Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for Tutorial 1, archives the old tutorial notebook, and ensures the Jupyter notebook is correctly translated into the docs.
- Removed the deprecated
plotting.pcaentry from the API docs. - Archived the old Proteomics Integration notebook and cleaned up the main notebook.
- Updated the tutorial index headings and link labels for consistency.
Reviewed Changes
Copilot reviewed 4 out of 11 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/api/plotting.md | Removed the plotting.pca entry from the list |
| docs/Tutorials/index.md | Changed heading levels to ## and renamed the “Tutorials” section to “Tutorial links” |
| docs/Tutorials/T2_ProteomicsIntegration.ipynb | Removed the standalone title cell from the main tutorial |
| docs/Tutorials/old/T2_ProteomicsIntegration.ipynb | Added archived version of the Proteomics Integration notebook |
Comments suppressed due to low confidence (3)
docs/api/plotting.md:27
- If
plotting.pcais still supported in the code, please re-add it or note its deprecation and redirect users to the newplotting.pca_loadingsfunction.
plotting.pca_loadings
docs/Tutorials/index.md:19
- [nitpick] The link text uses lowercase “analysis” but the heading is “Image Analysis”; consider matching the casing for consistency.
- [Tutorial 1: Image analysis](T1_ImageAnalysis)
docs/Tutorials/T2_ProteomicsIntegration.ipynb:3
- [nitpick] The top markdown cell with the tutorial title was removed; consider restoring a header cell (e.g.
# Integrating proteomics and imaging data) for clarity in standalone notebook views.
{
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.
ensured tutorial 1 changes, and jupyter notebook translation into docs work.