[GRASS-git] [OSGeo/grass] 7c2701: docs: Use more crossrefs in grass.script.core (#5868)

Edouard Choinière noreply at github.com
Tue Jun 10 17:14:57 PDT 2025


  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 7c2701973ff6979f636aeba790520bbd6a2e29de
      https://github.com/OSGeo/grass/commit/7c2701973ff6979f636aeba790520bbd6a2e29de
  Author: Edouard Choinière <27212526+echoix at users.noreply.github.com>
  Date:   2025-06-11 (Wed, 11 Jun 2025)

  Changed paths:
    M python/grass/pygrass/gis/region.py
    M python/grass/pygrass/raster/__init__.py
    M python/grass/pygrass/vector/basic.py
    M python/grass/pygrass/vector/find.py
    M python/grass/script/core.py
    M python/grass/script/raster.py
    M python/grass/script/raster3d.py

  Log Message:
  -----------
  docs: Use more crossrefs in grass.script.core (#5868)

This PR changes some function names, class names, etc. to use cross-references when applicable. Mostly centered around grass.script.core (the main topic, I reviewed that file completely), but includes related changes when searching for other instances to apply the same changes.

This does not include cross-references to exceptions, as it will be bundled separately, there's some original work (new text) created in these, so I didn't want to mix them up.

* docs: Use crossrefs in docstrings of grass.pygrass.gis.region

* docs: Fix ambiguity in ScriptError reference in grass.script.core

* docs: Add cross-refs to classes, exceptions, functions, etc in grass.script.core docstrings

* docs: Add cross-refs to RegionManager docstrings

* docs: Resolve ambiguous references to types or functions generating warnings

* docs: Use double backticks for inline code style in grass.script.core.read_command()



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


More information about the grass-commit mailing list