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

epic: Docstrings / documentation approach that labels experimental features #239

Open
machow opened this issue Mar 11, 2024 · 1 comment
Assignees
Labels
.epic Big features and initiatives

Comments

@machow
Copy link
Collaborator

machow commented Mar 11, 2024

Currently, we are interested in pushing out features quickly. This is reflected especially in our docs, which simply push from main. This means that our docs can diverge from PyPI reality until we cut a release.

To be able to move quickly, but also set people's expectations, we should mark some features as experimental. It would be useful if people...

  • Saw an experimental note in the docstring, IDE static hover over hint stuff, and web documentation
  • Could click through on the web, to get some more information about what experimental means.
  • The version in which something was added.
  • (Optional), a badge for experimental a la r-lib/lifecycle.
@machow machow added the .epic Big features and initiatives label Mar 11, 2024
@machow machow self-assigned this Mar 11, 2024
@machow machow changed the title Docstrings / documentation approach that labels experimental features epic: Docstrings / documentation approach that labels experimental features Mar 11, 2024
@machow
Copy link
Collaborator Author

machow commented Mar 15, 2024

We just put a callout in the docstring of things like fmt_nanoplot, which feels okay for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.epic Big features and initiatives
Projects
None yet
Development

No branches or pull requests

1 participant