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

Improve documentation #2015

Merged
merged 3 commits into from
Sep 9, 2024
Merged

Improve documentation #2015

merged 3 commits into from
Sep 9, 2024

Conversation

vkbo
Copy link
Owner

@vkbo vkbo commented Sep 1, 2024 •
edited
Loading

Summary:

Some improvements to documentation based on user questions.

Related Issue(s):

Reviewer's Checklist:

  • The header of all files contain a reference to the repository license
  • The overall test coverage is increased or remains the same as before
  • All tests are passing
  • All flake8 checks are passing and the style guide is followed
  • Documentation (as docstrings) is complete and understandable
  • Only files that have been actively changed are committed

@vkbo vkbo added this to the Release 2.5.2 milestone Sep 1, 2024
@vkbo vkbo merged commit 5ac0017 into release Sep 9, 2024
8 checks passed
@vkbo vkbo deleted the improve_docs branch September 9, 2024 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Release 2.5.2
Development

Successfully merging this pull request may close these issues.
1 participant
@vkbo