DOCS: Update Documentation for UI Redesign#187
Merged
Conversation
zdomke
added
documentation
zdomke
force-pushed
the
zdomke/docs-update
branch
from
2ca37d0 to
1f9935b
Compare
Collaborator
Author
|
Opening for review now. The documentation is not complete, but it is in a good state now to launch. Will add more doc updates in another PR. |
Collaborator
Author
|
Moving forward, users should include docstrings on their functions (and possibly classes). We are following the numpydoc format. |
ngAlexander9
approved these changes
Sep 2, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Updating the documentation pages for Trace. This consists of replacing content in the How To pages, restructuring the API Reference pages, and adding some extra features to the
mkdocs.yml.https://slaclab.github.io/trace/
Motivation
Our documentation should be as good or better than the code in our application.
Closes #4 and SWAPPS-320.
Pre-merge checklist