Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for existing plotting classes to the project's documentation structure. It creates new documentation pages for plotting functionality and updates the navigation to include them.
- Adds plotting section to the documentation navigation with two subsections
- Updates code example in RateDetectionPlotting class to use newer API method names
- Creates documentation pages for RateDetectionPlotting and PixelMapPlotting classes
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yml | Adds new "Plotting" section to navigation with Rate Detection and PixelMap subsections |
| eitprocessing/plotting/rate_detection.py | Updates docstring example to use current API method names and adds more complete example |
| docs/api/plotting/rate_detection.md | Creates documentation page for RateDetectionPlotting class |
| docs/api/plotting/pixelmap.md | Creates documentation page for PixelMapPlotting class |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
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.
Adds existing plotting classes to documentation.