Skip to content

Docs/new user guide - #816

Merged
munechika-koyo merged 22 commits into
mainfrom
docs/new-user-guide
Sep 9, 2026
Merged

Docs/new user guide#816
munechika-koyo merged 22 commits into
mainfrom
docs/new-user-guide

Conversation

@cvanelteren

Copy link
Copy Markdown
Collaborator

Taking a few steps to have a softer introduction for newcomers.

Comment thread docs/keyword_aliases.rst
==================

UltraPlot accepts a broad set of keyword spellings so existing Matplotlib and
older UltraPlot code continues to work. New users only need a small canonical

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean older ProPlot code ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same/same in this case I can add the disclaimer.

Comment thread docs/first_figure.py
abcstyle='(a)',
abc_kw={'fontsize': 11},
)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This formatting style—with one parameter per line—may align with coding conventions, but for this particular example it makes the code excessively long and requires too much scrolling, which severely hurts readability. I strongly suggest that, for this example, multiple parameters be placed on the same line as long as the line width allows.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can't otherwise our black check will trip. Unless I remove that but I also personally have no issue with longer text.

Comment thread docs/first_figure.py Outdated
Comment thread docs/first_figure.py Outdated
Comment thread docs/first_figure.py Outdated
Comment thread docs/first_figure.py Outdated
Comment thread docs/first_figure.py Outdated
Comment thread docs/first_figure.py Outdated
# right-hand panels receive approximately square plotting areas.
layout = [[1, 2], [1, 3]]

# 3. Create the figure

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is "# 2."?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May have inadvertently deleted it -- will correct.

Comment thread docs/why_ultraplot.py Outdated
cvanelteren and others added 9 commits September 8, 2026 18:48
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
Comment thread docs/first_figure.py Outdated
cvanelteren and others added 2 commits September 9, 2026 15:47
Co-authored-by: Koyo MUNECHIKA <51052381+munechika-koyo@users.noreply.github.com>
@munechika-koyo
munechika-koyo self-requested a review September 9, 2026 09:38
@munechika-koyo
munechika-koyo merged commit 3eeb5d0 into main Sep 9, 2026
13 checks passed
@munechika-koyo
munechika-koyo deleted the docs/new-user-guide branch September 9, 2026 09:40
@cvanelteren

Copy link
Copy Markdown
Collaborator Author

For next time give the grace for the PR'er to give the go-ahead to merge @munechika-koyo -- in this case it is not crucial, but wanted to maybe tweak some stuff now.

@munechika-koyo

Copy link
Copy Markdown
Collaborator

I mistakenly thought I should have merged this as soon as we approved it.
I apologize. I will follow your instructions.

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.

3 participants