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

added example docstrings #3453

Merged
merged 1 commit into from
Nov 10, 2023
Merged

added example docstrings #3453

merged 1 commit into from
Nov 10, 2023

Conversation

chiamp
Copy link
Collaborator

@chiamp chiamp commented Oct 30, 2023

Resolves #2782.

Added example usages for Module's docstrings. Docstrings will now also be tested on CI via doctest

@chiamp chiamp self-assigned this Oct 30, 2023
@chiamp chiamp marked this pull request as draft October 30, 2023 21:24
@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 52.16%. Comparing base (50de4c4) to head (72e217e).
Report is 818 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #3453       +/-   ##
===========================================
- Coverage   83.63%   52.16%   -31.48%     
===========================================
  Files          56       91       +35     
  Lines        6802    10954     +4152     
===========================================
+ Hits         5689     5714       +25     
- Misses       1113     5240     +4127     

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

@chiamp chiamp marked this pull request as ready for review October 30, 2023 21:37
@chiamp chiamp marked this pull request as draft October 30, 2023 21:37
@chiamp chiamp force-pushed the docstrings branch 11 times, most recently from 3e6baa6 to 2bf8981 Compare November 3, 2023 21:27
@chiamp chiamp force-pushed the docstrings branch 14 times, most recently from 99b12f0 to 212ab36 Compare November 7, 2023 22:39
@chiamp chiamp force-pushed the docstrings branch 15 times, most recently from 2f12bb3 to 2584342 Compare November 8, 2023 23:59
@chiamp chiamp marked this pull request as ready for review November 9, 2023 00:13
@chiamp chiamp requested a review from cgarciae November 9, 2023 00:59
flax/linen/attention.py Outdated Show resolved Hide resolved
flax/linen/attention.py Outdated Show resolved Hide resolved
@cgarciae
Copy link
Collaborator

Awesome @chiamp!!!
This has to be one of the biggest improvement to the our docstrings to date 🚀

@copybara-service copybara-service bot merged commit e959dbf into google:main Nov 10, 2023
19 checks passed
@chiamp chiamp deleted the docstrings branch November 15, 2023 02:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Example Documentation
3 participants