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

Add docs for mixin operators #658

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Add docs for mixin operators #658

wants to merge 1 commit into from
+308 −13

Conversation

sleeepyjack
Copy link
Collaborator

@sleeepyjack sleeepyjack commented Jan 16, 2025 •
edited
Loading

This PR adds publicly available inline docs for device operators.

Closes #371

@sleeepyjack sleeepyjack added type: docs Improvements or additions to documentation P1: Should have Necessary but not critical labels Jan 16, 2025
@sleeepyjack sleeepyjack self-assigned this Jan 16, 2025
@sleeepyjack
Copy link
Collaborator Author

sleeepyjack commented Jan 16, 2025 •
edited
Loading

The current solution with documenting parameters (@see) might not be ideal and I haven't checked how the current approach renders to HTML. However, this is something we can fix once we are ready to build the docs using sphinx. At least the doxygen check doesn't complain for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PointKernel PointKernel Awaiting requested review from PointKernel PointKernel is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@sleeepyjack sleeepyjack

Labels
P1: Should have Necessary but not critical type: docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[ENHANCEMENT]: Mixin operators should be documented in the public API
1 participant
@sleeepyjack