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

fix rendering of tables in docstrings #86

Merged
merged 1 commit into from
Apr 9, 2020

Conversation

hoefling
Copy link
Contributor

@hoefling hoefling commented Apr 9, 2020

Signed-off-by: oleg.hoefling [email protected]

@hoefling hoefling requested a review from Cito as a code owner April 9, 2020 13:07
@Cito Cito merged commit 555a266 into graphql-python:master Apr 9, 2020
@Cito
Copy link
Member

Cito commented Apr 9, 2020

Thank you for these fixes!

@hoefling hoefling deleted the table-rendering-issue branch April 9, 2020 15:22
@hoefling
Copy link
Contributor Author

@Cito gladly! Would you mind accepting more improvements for docstrings? I have noticed some usage of single backticks clearly intended to render verbatim blocks, e.g. __typename here or extend_schema (here). Also, some docstrings could have more internal crossrefs, e.g. graphql.parse_value could benefit from adding crossrefs to GraphQLError and value_from_ast etc.

@Cito
Copy link
Member

Cito commented Apr 11, 2020

@hoefling Sure, I'd appreciate any help with that. Actually I mostly just copied the docstrings which were written for JSDoc without thinking much about how they render with Sphinx and ReST. Maybe we can also make use of newer autodoc features - I haven't looked into that yet.

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