Skip to content

Improve documentation on Postponed Annotations#487

Merged
samuelcolvin merged 1 commit intopydantic:masterfrom
theenglishway:doc-update
Apr 24, 2019
Merged

Improve documentation on Postponed Annotations#487
samuelcolvin merged 1 commit intopydantic:masterfrom
theenglishway:doc-update

Conversation

@theenglishway
Copy link
Copy Markdown
Contributor

@theenglishway theenglishway 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
Copy link
Copy Markdown
Contributor Author

theenglishway 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
Copy link
Copy Markdown

codecov Bot 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
Copy link
Copy Markdown
Member

samuelcolvin commented Apr 23, 2019 •
edited
Loading

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

@theenglishway
Copy link
Copy Markdown
Contributor Author

theenglishway commented Apr 23, 2019

PR updated after our discussion on #486

@samuelcolvin samuelcolvin merged commit e5b8ec7 into pydantic:master Apr 24, 2019
@samuelcolvin
Copy link
Copy Markdown
Member

samuelcolvin commented Apr 24, 2019

thanks a lot.

@theenglishway
Copy link
Copy Markdown
Contributor Author

theenglishway commented Apr 25, 2019

Thanks for that very nice library 👍

alexdrydew pushed a commit to alexdrydew/pydantic that referenced this pull request Dec 23, 2023
@dmontagu
Uprev version to 0.17.0 (pydantic#487)
81c8ad7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@theenglishway @samuelcolvin