NWChemEx / NWChemEx/PluginPlay
[QUESTION] Python API Documentation
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 13
- Forks
- 1
- Avg merge
- 43m
- Merged PRs (30d)
- 4
Description
Currently, the documentation links to the C++ API documentation, but there is no Python API link. Do you plan to generate this as well from the Python bindings? If not, what is the expected method to know what is part of the Python API (and what is excluded from the Python API) in the C++ docs?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the linked C++ API documentation and the project’s Python bindings to determine whether Python API documentation is generated. Document the expected way to identify what belongs to the Python API and whether a separate Python API link is planned; the issue is complete when this guidance is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100