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

Improve documentation on Postponed Annotations #487

Merged
merged 1 commit into from Apr 24, 2019

Conversation

Projects
None yet
2 participants
@theenglishway
Copy link
Contributor

commented Apr 23, 2019

Change Summary

Update paragraph on Postponed Annotations in the documentation, with a more relevant example and emphasis on the bits of code that are required to make it work (pushing technical-only notes into ... notes).

Related issue number

#486

Checklist

  • [ x] Unit tests for the changes exist
  • [ x] Tests pass on CI and coverage remains at 100%
  • [ x] Documentation reflects the changes where applicable
  • [ x] HISTORY.rst has been updated
    • if this is the first change since a release, please add a new section
    • include the issue number or this pull request number #<number>
    • include your github username @<whomever>
@theenglishway

This comment has been minimized.

Copy link
Contributor Author

commented Apr 23, 2019

I'm still completely unclear about the ForwardRef section but I guess the documentation would be clearer if it was removed altogether ...

@codecov

This comment has been minimized.

Copy link

commented Apr 23, 2019

Codecov Report

Merging #487 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master   #487   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          14     14           
  Lines        2251   2251           
  Branches      443    443           
=====================================
  Hits         2251   2251
@samuelcolvin

This comment has been minimized.

Copy link
Owner

commented Apr 23, 2019

See my comment on #486, think you might need to read PEP0563.

@theenglishway theenglishway force-pushed the theenglishway:doc-update branch from 307451b to cfa7332 Apr 23, 2019

@theenglishway

This comment has been minimized.

Copy link
Contributor Author

commented Apr 23, 2019

PR updated after our discussion on #486

@samuelcolvin samuelcolvin merged commit e5b8ec7 into samuelcolvin:master Apr 24, 2019

4 of 7 checks passed

Header rules No header rules processed
Details
Pages changed 4 new files uploaded
Details
Redirect rules No redirect rules processed
Details
Mixed content No mixed content detected
Details
codecov/project 100% remains the same compared to 94c27b6
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
@samuelcolvin

This comment has been minimized.

Copy link
Owner

commented Apr 24, 2019

thanks a lot.

@theenglishway

This comment has been minimized.

Copy link
Contributor Author

commented Apr 25, 2019

Thanks for that very nice library 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.