shorelines parameter also accepts bool ?

[Esteban82]

Hi,
I'm not a Python expert, so I might be wrong — but I noticed that the documentation for the shorelines parameter (in pygmt.Figure.coast) says it accepts int, str, or list, like this:

shorelines (int, str, or list)

However, I tested it and it seems that bool also works. For example, this snippet from the "Making your first figure" tutorial uses shorelines=True, and it runs without errors:

fig = pygmt.Figure()
fig.coast(
    region=[-69, -68, 43.75, 44.75],
    shorelines=True,
    land="lightgreen",
    water="lightblue",
)
fig.show()

So maybe the documentation should mention that bool is also an accepted input for shorelines?
If I am right, I will happy to help. So, let me know what file should I modify.

Thanks!

[welcome]

👋 Thanks for opening your first issue here! Please make sure you filled out the template with as much detail as possible. You might also want to take a look at our contributing guidelines and code of conduct.

[seisman]

Yes, bool also works. I guess we have many "typos" like this one.

The documentation is generated from docstrings at

pygmt/pygmt/src/coast.py

Line 157 in 178c73d

shorelines : int, str, or list

.

[Esteban82]

Thanks. I've just made a PR