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.

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

[skip ci] 📝 Improve Documentation #913

Open
wants to merge 14 commits into
base: develop
Choose a base branch
from

Conversation

shaneahmed
Copy link
Member

  • Update CONTRIBUTING.rst

- Update CONTRIBUTING.rst
@shaneahmed shaneahmed self-assigned this Feb 19, 2025
@shaneahmed shaneahmed added this to the Release v1.7.0 milestone Feb 19, 2025
Copy link

codecov bot commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.90%. Comparing base (ba0109f) to head (ca472b3).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #913   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files           70       70           
  Lines         8735     8735           
  Branches      1149     1149           
========================================
  Hits          8727     8727           
  Misses           3        3           
  Partials         5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shaneahmed shaneahmed added the documentation Improvements or additions to documentation label Feb 20, 2025
@shaneahmed
Copy link
Member Author

@adamshephard please can you review edits to examples/README.md?

Copy link
Contributor

@adamshephard adamshephard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small changes to the text in comments.

@shaneahmed
Copy link
Member Author

@measty Please can you review docs/visualization.rst

@shaneahmed
Copy link
Member Author

@mostafajahanifar Please can you review installation.rst?

@measty
Copy link
Collaborator

measty commented Feb 21, 2025

@measty Please can you review docs/visualization.rst

looks fine to me

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants