Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Complete sphinx documentation #20

Open
tomuben opened this issue Aug 18, 2022 · 0 comments
Open

Complete sphinx documentation #20

tomuben opened this issue Aug 18, 2022 · 0 comments
Labels
documentation User guides, tutorials, specifications

Comments

@tomuben
Copy link
Collaborator

tomuben commented Aug 18, 2022 •
edited
Loading

Background

Add parameter documentation to functions, where parameters are not obvious:

https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html

Originally posted by @tkilias in #16 (comment)

Acceptance Criteria

Sphinx parameter documentation
@tomuben tomuben added the documentation User guides, tutorials, specifications label Aug 18, 2022
@tomuben tomuben mentioned this issue Aug 18, 2022
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation User guides, tutorials, specifications
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tomuben