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

📝 Refactor Documentation for ISBN and MAC address modules #124

Merged
merged 4 commits into from
Feb 12, 2024

Conversation

yezz123
Copy link
Collaborator

@yezz123 yezz123 commented Jan 9, 2024

I try it locally its working fine

@yezz123 yezz123 added the documentation Improvements or additions to documentation label Jan 9, 2024
@yezz123 yezz123 requested a review from sydney-runkle January 9, 2024 20:53
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d05c882) 100.00% compared to head (5caa73e) 100.00%.
Report is 10 commits behind head on main.

❗ Current head 5caa73e differs from pull request most recent head 2838771. Consider uploading reports for the commit 2838771 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #124   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          665       665           
  Branches       166       166           
=========================================
  Hits           665       665           

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

Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Looks good overall, but could you please add back the more informative docstrings?

pydantic_extra_types/isbn.py Outdated Show resolved Hide resolved
@sydney-runkle
Copy link
Member

I try it locally its working fine

Does this mean that you've tried serving the pydantic docs locally with these changes, and things run as expected?

@sydney-runkle
Copy link
Member

@yezz123,

Any chance you'll be able to incorporate some changes soon? Hoping to release a new version of pydantic and would love to get this new version of pydantic-extra-types in.

@yezz123 yezz123 requested a review from sydney-runkle January 12, 2024 16:49
@yezz123
Copy link
Collaborator Author

yezz123 commented Jan 12, 2024

@sydney-runkle we are ready to go!

@sydney-runkle
Copy link
Member

@yezz123,

Thanks for your work on this docs refactor. I'd like to provide some more feedback on some of the changes, and a lot of them aren't relevant to fixing the docs build issue we ran into with 2.4.0. I've opened a PR here to fix those issues, then I'll address these changes early next week! #125

Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

@yezz123,

Thanks for your work on this. I've left some general comments. Ping me once you'd like another review :).

pydantic_extra_types/isbn.py Show resolved Hide resolved
pydantic_extra_types/isbn.py Show resolved Hide resolved
pydantic_extra_types/isbn.py Show resolved Hide resolved
pydantic_extra_types/mac_address.py Show resolved Hide resolved
Copy link
Member

@sydney-runkle sydney-runkle left a comment

Choose a reason for hiding this comment

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

Great, thanks!

@sydney-runkle sydney-runkle merged commit f6dba1e into main Feb 12, 2024
18 checks passed
@sydney-runkle sydney-runkle deleted the fix-doc branch February 12, 2024 13:41
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.

2 participants