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

Standardize syntax for parameter values in the docstrings #3371

Open
joelostblom opened this issue Mar 16, 2024 · 0 comments
Open

Standardize syntax for parameter values in the docstrings #3371

joelostblom opened this issue Mar 16, 2024 · 0 comments

Comments

@joelostblom
Copy link
Contributor

This is a low priority observation. Currently we use a mix of double (formatted as code) and single (formatted as italics) backticks in doc strings. E.g. the Chart page formats methods as code and parameter values in italics:

image

whereas the doc on Projection formats everything as code:

image

In JupyterLab, the docstrings are not formatted; in VS Code, both single and double backticks are formatted as code (but the type hints are not formatted):

image

We currently mostly use single backticks, which is also more consistent with how the parameter values from the the automatic type hints are formatted as italics in the docs.

Personally I probably find it a bit easier to read when using double backticks, but I don't have a strong preference and not sure it's worth the effort to standardize, but wanted to note it down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant