Skip to content
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.

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

Consistent bullet point lists in docstrings #3556

Open
yvonnefroehlich opened this issue Oct 27, 2024 · 3 comments · May be fixed by #3572
Open

Consistent bullet point lists in docstrings #3556

yvonnefroehlich opened this issue Oct 27, 2024 · 3 comments · May be fixed by #3572
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@yvonnefroehlich
Copy link
Member

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:

  • modifier: docstring (e.g., connection)
  • modifier - docstring (e.g., gap)
  • modifier docstring (e.g., header)

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

@yvonnefroehlich yvonnefroehlich added documentation Improvements or additions to documentation discussions Need more discussion before taking further actions labels Oct 27, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.14.0 milestone Oct 27, 2024
@seisman
Copy link
Member

seisman commented Oct 27, 2024

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

@yvonnefroehlich
Copy link
Member Author

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

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

@weiji14
Copy link
Member

weiji14 commented Oct 28, 2024

Yep, ok with using :.

@seisman seisman removed the discussions Need more discussion before taking further actions label Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants