GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
767 stars 221 forks source link

Consistent bullet point lists in docstrings #3556

Open yvonnefroehlich opened 3 weeks ago

yvonnefroehlich commented 3 weeks ago

Let's take the documentation of Figure.plot (https://www.pygmt.org/dev/api/generated/pygmt.Figure.plot.html#pygmt.Figure.plot) as an example. Currently, we use different ways to write bullet point lists in the docstrings:

I feel it would be good to decide for one way and then update all docstrings accordingly.

seisman commented 3 weeks ago

Yes, I agree. Personally, I prefer using :.

yvonnefroehlich commented 3 weeks ago

Yes, I agree. Personally, I prefer using :.

@GenericMappingTools/pygmt-maintainers are there any other preferences? Otherwise we will go with :.

weiji14 commented 3 weeks ago

Yep, ok with using :.