Skip to content

Add lakes alias to Figure.coast() - #781

Merged
willschlitzer merged 10 commits into
GenericMappingTools:masterfrom
willschlitzer:coast-lakes-alias
Jan 5, 2021
Merged

Add lakes alias to Figure.coast()#781
willschlitzer merged 10 commits into
GenericMappingTools:masterfrom
willschlitzer:coast-lakes-alias

Conversation

@willschlitzer

@willschlitzerwillschlitzer commented Jan 2, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

Adding the lakes alias for the -C argument to Figure.coast().

@willschlitzer
willschlitzer marked this pull request as ready for review January 3, 2021 10:20
@willschlitzerwillschlitzer added the documentation Improvements or additions to documentation label Jan 3, 2021
@willschlitzerwillschlitzer added this to the 0.3.0 milestone Jan 3, 2021
@seisman

seisman commented Jan 3, 2021

Copy link
Copy Markdown
Member

Also see some discussions in #474 (comment).

Ping @GenericMappingTools/python for comments on the argument name.

seisman
seisman reviewed Jan 3, 2021
View reviewed changes
Comment threadpygmt/base_plotting.py Outdated
Comment threadpygmt/base_plotting.py Outdated
@willschlitzer@seisman
Update pygmt/base_plotting.py
825484b
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
willschlitzerand others added 2 commits January 4, 2021 07:08
@willschlitzer@seisman
Update pygmt/base_plotting.py
0b03a13
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@willschlitzer
Merge branch 'master' into coast-lakes-alias
6aac0d2
@willschlitzer

willschlitzer commented Jan 4, 2021

Copy link
Copy Markdown
ContributorAuthor

@seisman Looking at that PR, I'm not sure what the issue with using a long-name alias for C is. It seems like the main concern is backwards compatibility, but wouldn't scripts still be able to use C instead of the alias?

@seisman

seisman commented Jan 4, 2021

Copy link
Copy Markdown
Member

It seems like the main concern is backwards compatibility, but wouldn't scripts still be able to use C instead of the alias?

Yes, C always works.

We need to be very careful about choosing these long names. Sometimes we may find that the long names are inappropriate and have to change them to other names, which may break backward compatibility. For example, @weiji14 and I were thinking about changing sizes to size in plot() (#666 (comment)).

@seisman

seisman commented Jan 4, 2021

Copy link
Copy Markdown
Member

Just checked the documentation of coast(), I think lakes is a good name, considering that we already use "rivers", "shorelines" and "borders".

@seisman

seisman commented Jan 4, 2021

Copy link
Copy Markdown
Member

/format

seisman
seisman approved these changes Jan 4, 2021
View reviewed changes

@seismanseisman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

OK to merge after you fix this style issue:

pygmt/base_plotting.py:117:80: W505 doc line too long (83 > 79 characters)

@willschlitzer
willschlitzer merged commit a40a075 into GenericMappingTools:masterJan 5, 2021
@willschlitzer
willschlitzer deleted the coast-lakes-alias branch January 5, 2021 07:32
@seisman

seisman commented Jan 5, 2021

Copy link
Copy Markdown
Member

@willschlitzer When merging a PR, it would be better to simplify the commit description. For example, this is how this PR looks like after merging into the master branch.

image

A better one is:

image

@willschlitzer

willschlitzer commented Jan 6, 2021

Copy link
Copy Markdown
ContributorAuthor

@seisman Sounds good; my apologies for just leaving the defaults in.

@seismanseisman added enhancement Improving an existing feature and removed documentation Improvements or additions to documentation labels Jan 18, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@willschlitzer@seismanJosh Sixsmith
Add lakes alias to Figure.coast() (GenericMappingTools#781)
9758d41
* Add lakes alias to coast in base_plotting.py
* Changing color to fill
* Update coast docstring to r-string and change line lengths
* Add test for lake alias to test_coast.py
* Run make format
* Update pygmt/base_plotting.py
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
* Update pygmt/base_plotting.py
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
* Fixing doc string length
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes

Assignees

No one assigned

Labels

enhancementImproving an existing feature

Projects

None yet

Milestone

0.3.0

Development

Successfully merging this pull request may close these issues.

2 participants

@willschlitzer@seisman