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.

Sign up for GitHub

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

Jump to bottom

[ENHANCEMENT]: Mixin operators should be documented in the public API #371

Open
sleeepyjack opened this issue Sep 21, 2023 · 0 comments
Open

[ENHANCEMENT]: Mixin operators should be documented in the public API #371

sleeepyjack opened this issue Sep 21, 2023 · 0 comments
Labels
type: docs Improvements or additions to documentation

Comments

@sleeepyjack
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

Currently, the API docs for the mixin operators are hidden in the detail namespace here, which isn't ideal.

Describe the solution you'd like

We should either move or copy these docs to the class bodies of our *_ref classes since this is where the user expects them to be.

Describe alternatives you've considered

No response

Additional context

No response
@sleeepyjack sleeepyjack added the type: docs Improvements or additions to documentation label Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@sleeepyjack