Skip to content

Fix typo in AUTHORS.md #3313

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

Merged
merged 3 commits into from
Jul 5, 2024
Merged

Fix typo in AUTHORS.md #3313

merged 3 commits into from
Jul 5, 2024

Conversation

yvonnefroehlich
Copy link
Member

Description of proposed changes

I am wondering if the BibTeX entry (https://github.com/GenericMappingTools/pygmt?tab=readme-ov-file#citing-pygmt) also works with single curly braces (https://de.overleaf.com/learn/latex/Bibliography_management_with_bibtex#Enter_\(\mathrm{Bib\TeX}\).

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.
  • Use underscores (not hyphens) in names of Python files and directories.

Slash Commands

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

  • /format: automatically format and lint the code

@yvonnefroehlich yvonnefroehlich added the skip-changelog Skip adding Pull Request to changelog label Jul 5, 2024
@yvonnefroehlich yvonnefroehlich added this to the 0.13.0 milestone Jul 5, 2024
@yvonnefroehlich yvonnefroehlich self-assigned this Jul 5, 2024
README.md Outdated
@@ -151,7 +151,7 @@ research using the following BibTeX:
Ziebarth, Malte and
Quinn, Jamie and
Wessel, Paul},
title = {{PyGMT: A Python interface for the Generic Mapping Tools}},
title = {PyGMT: A Python interface for the Generic Mapping Tools},
Copy link
Member

@weiji14 weiji14 Jul 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The double curly brackets is set to preserve the proper capitalization of PyGMT (without it, LaTeX might render it as Pygmt). See e.g. https://tex.stackexchange.com/questions/7288/preserving-capitalization-in-bibtex-titles and https://en.wikibooks.org/wiki/LaTeX/Bibliography_Management#Preserving_case_of_letters.

We can also just do {{PyGMT}: A ...}, but putting double curly brackets on the left and right looks nicer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting! I was not aware of this issue. Redone in commit 9e868b5.

Copy link
Member

@weiji14 weiji14 Jul 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of those things you learn when a copyeditor goes through your BibTeX citations one by one and points out all the mistakes weiji14/deepbedmap@f86b366 🙂

@weiji14 weiji14 changed the title README / Citing PyGMT: Fix typos Fix typo in AUTHORS.md Jul 5, 2024
@weiji14 weiji14 merged commit f9a7aca into main Jul 5, 2024
6 checks passed
@weiji14 weiji14 deleted the fix-typos-70-citing branch July 5, 2024 07:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants