Skip to content

style: Fix flake8 E501 in man/build_md.py - #7422

Merged
petrasovaa merged 1 commit into
OSGeo:mainfrom
gkneighb:style-1522-build-md-e501
May 23, 2026
Merged

petrasovaa merged 1 commit into
OSGeo:mainfrom
gkneighb:style-1522-build-md-e501

Conversation

@gkneighb

Copy link
Copy Markdown
Contributor

Description

man/build_md.py had one long line (a string template) and a corresponding man/build_md.py: E501 entry in .flake8. Reword the long line so it fits in 88 columns, then drop the per-file-ignore.

- To learn more about these tool in general, go to [${modclass} introduction](${modclass_lower}intro.md).
+ To learn more, see the [${modclass} introduction](${modclass_lower}intro.md).

The new text is semantically equivalent (and incidentally fixes the "these tool" -> singular grammar slip).

Motivation and context

One of the cleanups invited by #1522.

How has this been tested?

python3 -m flake8 man/build_md.py exits 0 with the per-file-ignore removed. The other man/build_md.py: E501 candidates I looked at (build_html.py, m.distance.py, r.semantic.label.py, python/grass/jupyter/__init__.py) all hit either GRASS parser directive lines (# % description: that g.parser reads as a single line) or URLs inside ReST docstrings -- those cases are intentionally what # noqa-style ignores exist for, so I left their entries alone.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • PR title provides summary of the changes and starts with one of the pre-defined prefixes
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.

AI-assisted by Claude Code.

@github-actions github-actions Bot added CI Continuous integration raster Related to raster data processing Python Related code is in Python HTML Related code is in HTML module docs markdown Related to markdown, markdown files labels May 21, 2026
Reword the only long line in man/build_md.py from "To learn more about
these tool in general, go to [link]" to "To learn more, see the [link]"
so the line fits in 88 columns, then drop the file's E501 entry from
.flake8.

This is one of the cleanups invited by OSGeo#1522. Verified that flake8 still
passes on the file with the per-file-ignore removed.

AI-assisted by Claude Code.

References OSGeo#1522
@gkneighb
gkneighb force-pushed the style-1522-build-md-e501 branch from f843762 to 6fbbf86 Compare May 21, 2026 00:41
@echoix echoix removed CI Continuous integration raster Related to raster data processing Python Related code is in Python HTML Related code is in HTML module docs markdown Related to markdown, markdown files labels May 21, 2026
@github-actions github-actions Bot added CI Continuous integration Python Related code is in Python docs labels May 21, 2026

@petrasovaa petrasovaa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@petrasovaa
petrasovaa merged commit 7066751 into OSGeo:main May 23, 2026
27 checks passed
@github-actions github-actions Bot added this to the 8.6.0 milestone May 23, 2026
ninsbl pushed a commit to ninsbl/grass that referenced this pull request Jul 7, 2026
Reword the only long line in man/build_md.py from "To learn more about
these tool in general, go to [link]" to "To learn more, see the [link]"
so the line fits in 88 columns, then drop the file's E501 entry from
.flake8.
This is one of the cleanups invited by OSGeo#1522. Verified that flake8 still
passes on the file with the per-file-ignore removed.
AI-assisted by Claude Code.

Co-authored-by: gkneighb <26003+gkneighb@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous integration docs Python Related code is in Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants