[GRASS-git] [OSGeo/grass] 8d61b7: docs: Convert docstrings to use note and warning a...

[Edouard Choinière]

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

  Changed paths:
    M python/grass/gunittest/case.py
    M python/grass/pydispatch/dispatcher.py
    M python/grass/pygrass/gis/region.py
    M python/grass/pygrass/messages/__init__.py
    M python/grass/pygrass/modules/interface/module.py
    M python/grass/pygrass/raster/segment.py
    M python/grass/pygrass/vector/geometry.py
    M python/grass/pygrass/vector/table.py
    M python/grass/script/db.py
    M python/grass/temporal/c_libraries_interface.py
    M scripts/g.extension/g.extension.py

  Log Message:
  -----------
  docs: Convert docstrings to use note and warning admonitions (#5820)

Makes use of admonitions for notes and warnings. I searched "note" and "warning" in .py files for candidates to better displaying the notes. I didn't find other candidates for "caution", "warn", "info".

* docs: Convert docstrings to use note admonitions

* docs: Replace html syntax in docstring of db_select() in python/grass/script/db.py

* docs: Fix missing second colon in admonitions in docstrings

* docs: Remove space between admonition and double colon

* docs: Use warning admonition in docstring for python/grass/pygrass/gis/region.py



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