Skip to content

Conversation

@moe-ad
Copy link
Contributor

@moe-ad moe-ad commented Feb 14, 2025

Summary

As stated in the title

Details

The following have been done:

  • User, Developer, and Documentarian subsections added to the contribute section.
  • Use cases of tox added to Developer and Documentarian subsections.
  • Environment variables added to allow exclusion of API and examples during documentation generation in a local environment.

@codecov
Copy link

codecov bot commented Feb 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.62%. Comparing base (05c565c) to head (053b4a8).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2085      +/-   ##
==========================================
+ Coverage   86.60%   86.62%   +0.02%     
==========================================
  Files          90       90              
  Lines       10282    10275       -7     
==========================================
- Hits         8905     8901       -4     
+ Misses       1377     1374       -3     

@moe-ad
Copy link
Contributor Author

moe-ad commented Feb 17, 2025

Moving to ready for review to check generated documentation

@moe-ad moe-ad marked this pull request as ready for review February 17, 2025 09:49
@PProfizi PProfizi added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 19, 2025
Copy link
Contributor

@Revathyvenugopal162 Revathyvenugopal162 left a comment

Choose a reason for hiding this comment

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

small suggestions

@moe-ad moe-ad self-assigned this Feb 20, 2025
@moe-ad moe-ad merged commit 19ac25a into master Feb 24, 2025
45 checks passed
@moe-ad moe-ad deleted the feat/improve-contribution-documentation branch February 24, 2025 08:48
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 enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants