Skip to content

Fix references in documentation for clarity #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cvanelteren merged 2 commits into from
Dec 10, 2025
Merged

Fix references in documentation for clarity #421

cvanelteren merged 2 commits into from
Dec 10, 2025

Conversation

@gepcel
Copy link
Contributor

@gepcel gepcel commented Dec 10, 2025

Fix two unidenfined references in why.rst.

  1. ug_apply_norm is a typo I think.
  2. ug_mplrc. I'm not sure what it should be. Only by guess.

@gepcel
Fix references in documentation for clarity
6a2024c 
Fix two unidenfined references in why.rst.
1. ug_apply_norm is a typo I think.
2. ug_mplrc. I'm not sure what it should be. Only by guess.
@cvanelteren
Copy link
Collaborator

cvanelteren commented Dec 10, 2025

Thanks!
Let's flip the ref around for consistency.

@cvanelteren cvanelteren merged commit f8fb44b into Ultraplot:main Dec 10, 2025
6 of 7 checks passed
@gepcel
Copy link
Contributor Author

gepcel commented Dec 10, 2025 •
edited
Loading

I've just simply search both ug_norm and ug_apply_norm. There is a reference point called ug_norm, and it's used in many places, that why I choose this. But ug_apply_norm points nowhere.

@cvanelteren
Copy link
Collaborator

cvanelteren commented Dec 10, 2025

Ah wait is there? I did a global search too and found just one reference, where else did you find it?

@gepcel
Copy link
Contributor Author

gepcel commented Dec 11, 2025 •
edited
Loading

Hah, that's weird.

Searching 41 files for "ug_norm"

C:\UltraPlot-doc-reference\docs\2dplots.py:
  264: # or negative, and `diverging` is used with the :ref:`diverging normalizer <ug_norm>`
  345: # .. _ug_norm:
  350: # UltraPlot includes two new :ref:`"continuous" normalizers <ug_norm>`. The
  437: # continuous normalizers specified by `norm` (see :ref:`above <ug_norm>`).
  550: # -- see :ref:`above <ug_norm>`) if the following conditions are met:
C:\UltraPlot-doc-reference\docs\colorbars_legends.py:
  302: # * The associated :ref:`colormap normalizer <ug_norm>` can be specified with the
C:\UltraPlot-doc-reference\docs\why.rst:
  504:   uneven color gradations useful for :ref:`unusual data distributions <ug_norm>`.

@cvanelteren
Copy link
Collaborator

cvanelteren commented Dec 11, 2025

Strange now my editor (Zed) does pick them up. I will fix it in another PR. Thanks!

@gepcel gepcel deleted the doc-reference branch December 11, 2025 02:12
@cvanelteren cvanelteren mentioned this pull request Dec 11, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@gepcel @cvanelteren