Explain `function` and `module` directives in API doc best practices
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Consider explaining how the .. function:: and .. module:: directives work, specifically that they don't produce headings displayed in the right menu. This means that each new function section should start with an .. _anchor:, which should do either of the following:
- Be linked to in the "List of all functions"/"Index" section on the module page. This way the reader can follow the link to go to the desired page.
- Be put in the hidden
.. toctree::on the module page. This way the link to a specific function API appears in the left menu in the tree.
Follow-up to #3024
Originally posted by @patiencedaur in https://github.com/tarantool/doc/pull/3024#issuecomment-1187223386
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
Start with the API documentation best-practices material referenced by the issue and review follow-up #3024. Explain the behavior of the .. function:: and .. module:: directives, then document how anchors should be linked from the functions index or included in a hidden toctree.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100