[GRASS-git] [OSGeo/grass] 001580: docs: Adjust more code-blocks syntax and inside ex...

[Edouard Choinière]

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

  Changed paths:
    M python/grass/exceptions/__init__.py
    M python/grass/jupyter/interactivemap.py
    M python/grass/jupyter/map.py
    M python/grass/jupyter/map3d.py
    M python/grass/jupyter/seriesmap.py
    M python/grass/jupyter/timeseriesmap.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/script/core.py
    M python/grass/script/db.py
    M python/grass/script/imagery.py
    M python/grass/script/raster.py
    M python/grass/script/raster3d.py
    M python/grass/script/setup.py
    M python/grass/script/utils.py
    M python/grass/script/vector.py
    M python/grass/temporal/abstract_dataset.py
    M python/grass/temporal/gui_support.py
    M python/grass/temporal/spatio_temporal_relationships.py

  Log Message:
  -----------
  docs: Adjust more code-blocks syntax and inside example sections in docstrings (#5862)

This is another round of making the formatting of code blocks either valid, better, or semantically better represented in example sections headers (that is, indented, but also represented inside the field list element in the HTML render, not just underneath).


One place, `Region.get_bbox()` (in python/grass/pygrass/gis/region.py), I created more docstring contents (for the return description and return type), to align with the rest around it.

* docs: Fix code block syntax in grass.exceptions

* docs: Fix code block formatting of grass.script.core

* docs: Fix code block formatting of grass.pygrass.gis.region

* docs: Make Example code blocks indented inside the header in the rendered page

* docs: Fix code block formatting in grass.script.core

* docs: Move up example of region_env() to group return and return type together

* docs: Make Example code blocks indented inside the header in the rendered page, by removing empty line between field list and code block

* docs: Make "Basic usage" code blocks indented inside the header in the rendered page, for grass.jupyter

* docs: Make "Usage" code blocks indented inside the header in the rendered pages

* docs: Make "Example" code blocks indented inside the header in the rendered pages, in grass.script and grass.temporal

* docs: Make "Basic usage" code blocks indented inside the header in the rendered pages, in grass.script

Also fixing the python code syntax when the code blocks were not being reformatted.



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