Skip to content

fix(docs): correct example and visualization docs#1

Open
favilances wants to merge 2 commits into
utkukose:mainfrom
favilances:fix/example-11-docs
Open

fix(docs): correct example and visualization docs#1
favilances wants to merge 2 commits into
utkukose:mainfrom
favilances:fix/example-11-docs

Conversation

@favilances
Copy link
Copy Markdown

@favilances favilances commented Jun 6, 2026

This PR fixes documentation inconsistencies in the examples and visualization docs.

Changes:

  • Corrects the Example 11 script name in the README from 11_gemex_tabular_plots.py to 11_alternative_plots_tabular.py.
  • Updates the Example 11 script docstring and usage examples to match the actual filename.
  • Updates the README visualization count from 13 to 14 and adds the missing dependence plot documentation.
  • Clarifies that Example 14 showcases all applicable tabular plot types, adds the dependence plot to that showcase, and notes that image_trio is image-only.
  • Removes development comments left in gemex/viz/plots.py.

Checks:

  • python -m py_compile examples/11_alternative_plots_tabular.py examples/14_all_plots_showcase.py gemex/viz/plots.py
  • git diff --check HEAD~2..HEAD

Both checks passed with no issues.

@favilances favilances changed the title fix(docs): correct Example 11 script name fix(docs): correct example and visualization docs Jun 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant