Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'type' and 'default' tags are not recognized in parameter description #2

Open
krivenko opened this issue Nov 9, 2017 · 0 comments
Open

Comments

@krivenko
Copy link
Contributor

krivenko commented Nov 9, 2017

I am looking at the auto-generated solver_core_desc.py from cthyb.
Method solve() has a problem in its docstring.

+-------------------------------+------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter Name                | Type                                           | Default                                          | Documentation                                                                                                                                                                   |
+===============================+================================================+==================================================+=================================================================================================================================================================================+
| h_int                         | cthyb::many_body_op_t                          |                                                  | Interacting part of the atomic Hamiltonian\n     type: Operator                                                                                                                 |
+-------------------------------+------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| n_cycles                      | int                                            |                                                  | Number of QMC cycles                                                                                                                                                            |
+-------------------------------+------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| partition_method              | std::string                                    | "autopartition"                                  | Partition method\n     type: str                                                                                                                                                |
+-------------------------------+------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| quantum_numbers               | std::vector<many_body_op_t>                    | std::vector<many_body_op_t>{}                    | Quantum numbers\n     type: list(Operator)\n     default: []                                                                                                                    |
+-------------------------------+------------------------------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Before it was

+------------------------+-------------------------------------+-------------------------------+--------------------------------------------------------------------------------------------------------+
| Parameter Name         | Type                                | Default                       | Documentation                                                                                          |
+========================+=====================================+===============================+========================================================================================================+
| h_int                  | Operator                            |                               | Interacting part of the atomic Hamiltonian                                                             |
+------------------------+-------------------------------------+-------------------------------+--------------------------------------------------------------------------------------------------------+
| n_cycles               | int                                 |                               | Number of QMC cycles                                                                                   |
+------------------------+-------------------------------------+-------------------------------+--------------------------------------------------------------------------------------------------------+
| partition_method       | str                                 | "autopartition"               | Partition method                                                                                       |
+------------------------+-------------------------------------+-------------------------------+--------------------------------------------------------------------------------------------------------+
| quantum_numbers        | list(Operator)                      | []                            | Quantum numbers                                                                                        |
+------------------------+-------------------------------------+-------------------------------+--------------------------------------------------------------------------------------------------------+

As you can see, manually provided type and default fields are not extracted from the description anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant