[GRASS-git] [OSGeo/grass] 7b7710: docs: Fix reStructuredText markup in Python docstr...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 7b7710694b1d2a250a78a4b0ea94ed7828dcf880
      https://github.com/OSGeo/grass/commit/7b7710694b1d2a250a78a4b0ea94ed7828dcf880
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2026-07-17 (Fri, 17 Jul 2026)

  Changed paths:
    M python/grass/gunittest/runner.py
    M python/grass/imaging/images2avi.py
    M python/grass/pydispatch/dispatcher.py
    M python/grass/pygrass/raster/abstract.py
    M python/grass/pygrass/vector/geometry.py
    M python/grass/temporal/core.py
    M python/grass/tools/session_tools.py

  Log Message:
  -----------
  docs: Fix reStructuredText markup in Python docstrings (#7741)

The Sphinx build of the Python API documentation reports docutils
warnings and errors for docstrings with invalid reStructuredText, and
the affected docstrings also render badly. Fix the markup without
changing the documented content:

- grass.pydispatch.dispatcher: mark the two attribute listings as
  literal blocks, so that their plain-text layout is preserved instead
  of being misparsed as definition lists and block quotes.
- grass.pygrass.raster.abstract: drop the literal block marker in front
  of the doctest example of Info, so that the example is parsed as a
  doctest block. The expected output lines are not prefixed with ">>>",
  which made the quoting of the literal block inconsistent.
- grass.pygrass.vector.geometry: turn the parameter descriptions of the
  Node constructor into an actual field list.
- grass.gunittest.runner, grass.pygrass.vector.geometry,
  grass.tools.session_tools: escape or quote the asterisks so that
  "**kwargs" is not parsed as the start of inline strong markup.
- grass.imaging.images2avi: indent the continuation line of the bg_task
  field body, so that the field list is not cut short.
- grass.temporal.core: indent the content of the warning directive in
  init(), so that the directive is not empty.

This brings the number of warnings and errors reported by the Sphinx
build down from 42 to 19. Each fixed docstring is reported twice because
the subpackages are currently documented under two names.

The fixes were prepared with the help of Claude Code (AI) and verified
against the rendered HTML pages.



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications