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.

Sign up for GitHub

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

Jump to bottom

update documentation #138

Open
4 of 5 tasks
skuschel opened this issue Nov 22, 2017 · 1 comment
Open
4 of 5 tasks

update documentation #138

skuschel opened this issue Nov 22, 2017 · 1 comment
Labels
documentation Hacktoberfest beginner friendly task / part of Hacktoberfest high priority
Milestone
v1.0

Comments

@skuschel
Copy link
Owner

skuschel commented Nov 22, 2017 •
edited
Loading

  • update field docstring to match sphinx
  • update particle docstrings to match sphing
  • update top level module docstrings
  • update readme and provide links to sphinx
  • update contirbuting guidelines: How to write docstrings. Docstring template?
@skuschel skuschel self-assigned this Nov 22, 2017
@skuschel skuschel added this to the v0.4 milestone Nov 22, 2017
@skuschel skuschel mentioned this issue Mar 13, 2018
Merged
skuschel added a commit that referenced this issue Mar 13, 2018
@skuschel
Merge pull request #171 from skuschel/ku/doc
08bcda4 
documentation updates

Updates a lot of docstings, Readme, links to the postpic-examples repository.
Sphinx theme and sphinx autodoc.

Most of #138
@skuschel skuschel added the Hacktoberfest beginner friendly task / part of Hacktoberfest label Oct 4, 2018
@skuschel skuschel removed this from the v0.4 milestone Nov 5, 2018
@skuschel skuschel added this to the v0.5 milestone Jan 14, 2019
@skuschel skuschel modified the milestones: v0.5, v1.0 Sep 26, 2023
@skuschel skuschel removed their assignment Jan 2, 2024
@skuschel
Copy link
Owner Author

skuschel commented Jul 9, 2024

Probably: https://numpydoc.readthedocs.io/en/latest/example.html#example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Hacktoberfest beginner friendly task / part of Hacktoberfest high priority
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
1 participant
@skuschel