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

Elide operator file name from documentation #732

Open
hirzel opened this issue Jun 17, 2021 · 0 comments
Open

Elide operator file name from documentation #732

hirzel opened this issue Jun 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation usability

Comments

@hirzel
Copy link
Member

hirzel commented Jun 17, 2021

For example, the operator documentation should not say lale.lib.sklearn.quadratic_discriminant_analysis.QuadraticDiscriminantAnalysis, but rather use the simpler path lale.lib.sklearn.QuadraticDiscriminantAnalysis.

  • this makes the "class" line at the top of the page shorter, in some cases preventing it from spilling into the margin
  • also, this reduces confusion about where to import from
  • furthermore, we would also like to omit the submodules list from the package-level documentation

Hopefully, this can be solved by moving the set_docstring call from the operator.py file to the __init__.py file, and then renaming the file to add a leading underscore, as in, _operator.py.

@hirzel hirzel added documentation Improvements or additions to documentation usability labels Jun 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation usability
Projects
None yet
Development

No branches or pull requests

1 participant