Skip to content

Add "Typing Guidance for Python Libraries" document #889

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

Merged
merged 1 commit into from
Sep 14, 2021

Conversation

srittau
Copy link
Collaborator

@srittau srittau commented Sep 9, 2021

By Eric Traut, source: https://raw.githubusercontent.com/microsoft/pyright/main/docs/typed-libraries.md

See srittau/peps#94 for background.

This is a pristine copy of the original document. It needs to be
converted into RestructuredText and linked from the index as a next
step.

By Eric Traut, source: https://raw.githubusercontent.com/microsoft/pyright/main/docs/typed-libraries.md

See srittau/peps#94 for background.

This is a pristine copy of the original document. It needs to be
converted into RestructuredText and linked from the index as a next
step.
@srittau
Copy link
Collaborator Author

srittau commented Sep 9, 2021

Cc @erictraut

@stefanv
Copy link

stefanv commented Sep 9, 2021

@srittau Another route would be to configure Sphinx to parse Markdown files, since people seem to enjoy writing in that format and we want to encourage contribution.

Option 1: Use MyST which supports both markdown and RST.

Option 2: Use recommonmark by adding this and this line.

@srittau
Copy link
Collaborator Author

srittau commented Sep 9, 2021

While I usually prefer markdown, I'd prefer to keep using ReST exclusively here, for a few reasons:

  • To stay consistent within the documentation.
  • It's the standard for Python documentation.
  • To allow easy reshuffling between documents.
  • To be able to use advanced features like standardized crosslinks to Python documentation and index items.

@stefanv
Copy link

stefanv commented Sep 9, 2021

OK, here is the Pandoc conversion to RST, in case that's helpful to start with.

@srittau
Copy link
Collaborator Author

srittau commented Sep 9, 2021

Thanks! That's quite useful indeed.

@srittau
Copy link
Collaborator Author

srittau commented Sep 13, 2021

Bumpity bump. I'd like to start integrating the document into our docs structure. We can have all discussions about the contents then. For now, I'd like this original version to be in version control.

@JelleZijlstra JelleZijlstra merged commit 1d8fb26 into python:master Sep 14, 2021
@srittau srittau deleted the typing-libraries branch September 14, 2021 06:52
@srittau srittau added the topic: documentation Documentation-related issues and PRs label Oct 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA signed topic: documentation Documentation-related issues and PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants