Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Prettify docs#17

Merged
dkweiss31 merged 8 commits intodkweiss31:mainfrom
HarshBabla99:prettify-docs
Oct 30, 2025
Merged

Prettify docs#17
dkweiss31 merged 8 commits intodkweiss31:mainfrom
HarshBabla99:prettify-docs

Conversation

@HarshBabla99
Copy link
Contributor

Overall summary:

  • Removed a bunch of duplicate labels.
  • Reorganized docstrings to use the Google standard. Rewrote the datatypes so mkdocs can format them better.
  • Packaged examples and options into dropdown menus.
  • Added contributing.md to the docs (previously only accessible on github)
  • Tabbed mkdocs layout.
  • Fixed typo pointed out by Fix typo #5 .

@dkweiss31 feel free to make changes according to your style.

@HarshBabla99
Copy link
Contributor Author

Ready for review.

  • Updated ruff
  • Synced with main

@dkweiss31
Copy link
Owner

Made some small changes: if you agree then we can merge. Thanks very much for taking the time to improve the docs @HarshBabla99 !

@HarshBabla99
Copy link
Contributor Author

My pleasure. LGTM! 🚀

@dkweiss31 dkweiss31 merged commit 1e3bca8 into dkweiss31:main Oct 30, 2025
1 check passed
@HarshBabla99 HarshBabla99 deleted the prettify-docs branch October 30, 2025 13:42
@HarshBabla99 HarshBabla99 mentioned this pull request Oct 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants