Added alias for F in basemap

[jackbeagley]

Description of proposed changes

Adds an alias for "box" so that backgrounds and frames for map_scales can be generated more easily.

Fixes #1893

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
• If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[welcome]

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

• If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
• All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
• No matter what, we are really grateful that you put in the effort to do this! 🎉

[michaelgrund]

Thanks for opening this PR @jackbeagley. Besides adding an alias for -F could you please also provide the corresponding documentation part in the docstring? You can orientate yourself on the already existing ones for basemap.

[seisman]

Besides adding an alias for -F could you please also provide the corresponding documentation part in the docstring? You can orientate yourself on the already existing ones for basemap.

@jackbeagley FYI, the same box parameter has been aliased in the colorbar function, so you can simply copy (perhaps needs slight modifications) the box docstring from colorbar to basemap:

pygmt/pygmt/src/colorbar.py

Line 71 in 555cd31

box : bool or str

[jackbeagley]

@seisman , awesome, I have just copied the description from colorbar verbatim, as it seemed very well written and as you say - it is the same scale, so I don't think there is anything additional that needs to be added?

[jackbeagley]

Does a test need to be written for this too?

[seisman]

Does a test need to be written for this too?

I don't think a test is needed for such an alias.

[michaelgrund]

I think we have to consider the different types of map objects that can be manipulated such as map inset, map scale, or map rose.

[jackbeagley]

I think we have to consider the different types of map objects that can be manipulated such as map inset, map scale, or map rose.

Hey @michaelgrund, is that what you had in mind?

[welcome]

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.