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

Replace ToDo with link to Writing documentation in Inline Documentation tutorial #376

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Replace ToDo with link to Writing documentation in Inline Documentation tutorial #376

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aee6d38
Insert link to documentation
maxmynter Feb 11, 2024
9377927
style: pre-commit fixes
pre-commit-ci[bot] Feb 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/pages/tutorials/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ automatically generate nice-looking HTML documentation later. Notable features:

- (Optional) There is a section of one or more examples.

We will revisit docstrings in the section on writing documentation [TODO: link
once this section exists].
We will revisit docstrings in the section on writing
[documentation]({% link pages/tutorials/docs.md %}).

[snell's law]: https://en.wikipedia.org/wiki/Snell%27s_law
[numpydoc standard]: https://numpydoc.readthedocs.io/en/latest/format.html
Loading