Skip to content

Conversation

@tiangolo
Copy link
Contributor

@tiangolo tiangolo commented Oct 2, 2023

  • I updated the PEP to use a single class Doc(), no function doc().
  • I removed the section about "Additional Scenarios" as it seems it was creating more confusion than help.
  • I made it more explicit that "support" comes in at least two ways, editing and rendering.
  • I added explicit information about using type aliases and re-using documentation strings via type aliases.
  • I tried to clarify what Annotated documents, and how it would be overridden by wrapping type aliases in Annotated.
  • I made the argument to Doc() positional only.
  • I added a simpler bullet point list of the features this would address that are not addressed by current docstring conventions.
  • I added a simple note to suggest to render the docstring first and the parameter documentation later, or to allow configuring.
  • I updated several sections based on feedback from several in the discussion.
  • I updated the rejected ideas.
  • I added a short survey of how other languages document these things.

📚 Documentation preview 📚: https://pep-previews--3459.org.readthedocs.build/

@tiangolo tiangolo marked this pull request as ready for review October 2, 2023 16:37
@tiangolo tiangolo changed the title 📝 Update PEP 727 with latest implementation and feedback from discussion PEP 727: update with latest implementation and feedback from discussion Oct 2, 2023
Copy link
Member

@JelleZijlstra JelleZijlstra 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, a few formatting nits

@JelleZijlstra JelleZijlstra merged commit e271622 into python:main Oct 3, 2023
@tiangolo tiangolo deleted the update-pep-727 branch October 3, 2023 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants