Skip to content

Docs/new user guide - #816

Open
cvanelteren wants to merge 11 commits into
mainfrom
docs/new-user-guide
Open

Docs/new user guide#816
cvanelteren wants to merge 11 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.

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.

2 participants