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

[DOC] Add more canonical examples to the "Developing Documentation" page #4017

Open
KishManani opened this issue Dec 29, 2022 · 1 comment
Open
Labels
documentation Documentation & tutorials

Comments

@KishManani
Copy link
Contributor

Describe the issue linked to the documentation

Raising this from this discussion.

I found that in the docs of the TimeSince transformer that the parameters were not being correctly rendered. I looked here to find out how I could remedy this. I found it difficult to understand where indents, spaces, and newlines were required. I initially looked at examples in the link to NumPy docstring format. However, I was looking for an example where there is a list in the parameters section and could not find this. @aiwalter kindly re-directed me to the Imputer documentation.

Suggest a potential alternative/fix

Add more canonical examples which cover a wider range of scenarios (e.g., a list of types in the parameters section).

@KishManani KishManani added the documentation Documentation & tutorials label Dec 29, 2022
@KishManani KishManani changed the title [DOC] Add an example where there is a list in the parameters section. [DOC] Add more canonical examples to the "Developing Documentation" page Dec 29, 2022
@aiwalter
Copy link
Contributor

I am wondering if Sphinx docs are covering this? Maybe we can just link it if there is sth..

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

No branches or pull requests

2 participants