Add missing __doctest_skip__ directive in some methods/functions

[seisman]

Some doctests are mainly intended to demonstrate the usage of functions or methods rather than for actual testing. Such tests can be skipped using the __doctest_skip__ directive (initially introduced in PR #1790). However, it's easy to forget to add this directive to some methods or functions.

To help identify these cases, I asked ChatGPT to write a simple Python script that finds modules containing doctests but missing the __doctest_skip__ directive. It works, but still flags modules that shouldn't be reported. Thus, we can't add it to our CI workflow, but we can sometimes run it and review the report manually.

importdoctestimportpkgutilimportpygmtTARGETS= ("pygmt.src", "pygmt.datasets", "pygmt.params")
missing= []
formodinfoinpkgutil.walk_packages(pygmt.__path__, pygmt.__name__+"."):
name=modinfo.nameifnotname.startswith(TARGETS):
continuemodule=__import__(name, fromlist=["*"])
# Detect whether the module actually contains doctestsfinder=doctest.DocTestFinder()
tests=finder.find(module)
ifnotany(test.examplesfortestintests):
continueif"__doctest_skip__"notinmodule.__dict__:
missing.append(name)
ifmissing:
print(
"__doctest_skip__ missing in modules that contain doctests:\n"+"\n".join(f" - {m}"forminmissing)
)

This PR adds the missing __doctest_skip__ directives to the appropriate methods and functions.