Linting PR #179
Merged
Linting PR #179
Conversation
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
…checker was complaining
fsoubelet
added
Type: Documentation
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up markdown formatting, standardizes image accessibility attributes, updates link references, and converts TODOs to mkdocs-style admonitions across documentation.
- Remove extraneous blank lines around tables and sections
- Wrap images in
<center>, addaltattributes, and adjust reference URLs to reflect doc restructuring - Replace inline TODOs with mkdocs admonitions and remove a deprecated guide file
Reviewed Changes
Copilot reviewed 80 out of 80 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/logbook/LHC/2022_lhc.md | Removed redundant blank lines |
| docs/logbook/LEIR/2024_leir.md | Cleaned up extra blank before the shift table |
| docs/logbook/LEIR/2023_leir.md | Removed stray blank line |
| docs/logbook/AD/2024_ad.md | Tidied whitespace around table and tooltips |
| docs/guis/usage/remote.md | Wrapped figures in <center>, added alt attributes, added sshuttle reference |
| docs/guis/usage/releases.md | Converted TODO to !!! todo admonition |
| docs/guis/usage/kmod_special.md | Deleted deprecated KMod GUI special-features file |
| docs/guis/usage/ide_install.md | Updated clone URL, link syntax, and reference paths |
| docs/guis/betabeat/settings.md | Removed unnecessary whitespace |
| docs/guis/betabeat/plots.md | Removed trailing blank line |
| docs/guis/betabeat/optics_panel.md | Normalized markdown anchors and list formatting |
| docs/guis/betabeat/bpm_panel.md | Added alt attributes to images and standardized TODO blocks |
| docs/guis/betabeat/beam_selection.md | Added alt text, updated python path example, corrected omc3 link |
| docs/guis/betabeat/analysis_panel.md | Added alt attribute to the cleaning image |
| docs/guis/about.md | Updated link targets to mirror restructured directories |
| README.md | Switched to python -m pip for plugin installation |
Comments suppressed due to low confidence (1)
docs/guis/usage/remote.md:90
- The link reference
[sshuttle]is defined but not used in the document; consider adding a corresponding reference in the text or removing this unused definition.
[sshuttle]: https://sshuttle.readthedocs.io/en/stable/
JoschD
approved these changes
May 21, 2025
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.
This is going to be annoying to review :/
Also fixed all outdated / invalid anchor links. No more warnings in the builds.