docs: update PSLab app links#284
Open
macayu17 wants to merge 3 commits into
Open
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates documentation to point from the deprecated pslab-desktop GUI repository to the current PSLab app repository, keeping README and installation docs consistent. Flow diagram for updated GUI documentation linkflowchart LR
User["User reads PSLab documentation"] --> DecideGUI["Needs GUI for PSLab"]
DecideGUI --> InstallPython["Install pslab-python (CLI/acquisition)"]
DecideGUI --> VisitAppRepo["Open PSLab app repo (fossasia/pslab-app)"]
VisitAppRepo --> FollowReadme["Follow repo Readme to install GUI app"]
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="README.md" line_range="32" />
<code_context>
**Note**: Windows users who use the PSLab v6 device must download and install the CP210x Windows Drivers from the [Silicon Labs website](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) in order for pslab-python to be able to communicate with the PSLab device.
-**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop) and follow the instructions of the Readme in that repo.
+**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the Readme in that repo.
</code_context>
<issue_to_address>
**suggestion (typo):** Consider changing "Readme" to "README" to match the conventional filename.
This will align the reference with the actual filename in the repo and improve clarity for readers.
```suggestion
**Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the README in that repo.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates user-facing documentation to point to the current PSLab GUI application and aligns link formatting across RST/Markdown docs.
Changes:
- Replace the deprecated
pslab-desktoplink withpslab-appin installation docs. - Update README’s GUI note to reference
pslab-app.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/installation.rst | Switches GUI reference to pslab-app using proper reStructuredText link syntax. |
| README.md | Updates GUI note to link to the pslab-app GitHub repository. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Note**: Windows users who use the PSLab v6 device must download and install the CP210x Windows Drivers from the [Silicon Labs website](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads) in order for pslab-python to be able to communicate with the PSLab device. | ||
|
|
||
| **Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop) and follow the instructions of the Readme in that repo. | ||
| **Note**: If you are only interested in using PSLab as an acquisition device without a display/GUI, only pslab-python needs to be installed. If you would like a GUI, install the [PSLab app](https://github.com/fossasia/pslab-app) and follow the instructions of the Readme in that repo. |
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
|
|
||
| **Note**: pslab-python does not provide a graphical user interface. If you want | ||
| a GUI, install the [pslab-desktop app](https://github.com/fossasia/pslab-desktop). | ||
| a GUI, install the `PSLab app <https://github.com/fossasia/pslab-app>`__. |
Comment on lines
+20
to
+21
| ``pslab-python`` requires `Python <http://python.org/download/>`__ version | ||
| 3.6 or later. No newline at end of file | ||
| 3.6 or later. |
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.
Fixes #283
Changes
pslab-desktoprepo withfossasia/pslab-app.Testing
python -m buildtox -e docstox -e lintgit diff --checkI also ran
tox -e integration. It fails locally on the current upstream test setup, unrelated to this documentation change:tests/test_spi.pyandtests/test_uart.pybecause_frequency/_baudrateresolve as methods.pytest-mockis missing andtests/conftest.pycallsSerialHandler()without the requiredport.Summary by Sourcery
Update documentation to point to the current PSLab GUI application repository.
Documentation: