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

clarify id instructions #712

Merged
merged 1 commit into from
Dec 12, 2023
Merged

clarify id instructions #712

merged 1 commit into from
Dec 12, 2023

Conversation

Erin-Cecele
Copy link
Collaborator

Thank you for contributing to the Quire Documentation & Website! Please complete the form below to submit your pull request for review.

For the Title of this pull request, please use the format "Type/Issue-#: Brief description." For Type, the options are Edit, Add, Translate. Issue-# is only needed if this pull request addresses an existing issue.

Checklist

Please put an X within the brackets that apply [X].

  • I have read the CONTRIBUTING.md file.

  • I have made my changes in a new branch and not directly in the main branch

  • I am requesting feedback on a draft pull request

Is this pull request related to an open issue? If so, what is the issue number?

Yes: thegetty/quire#869

Please describe the goal of this pull request and the changes that were made.

Update recently revised guidelines to include "cannot start with a number / can only start with a lowercase letter".

Additional Comments

Copy link
Member

@geealbers geealbers left a comment

Choose a reason for hiding this comment

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

Do we talk about ids in contexts other than figures elsewhere in the docs? I think we probably should be consistent everywhere that they should always be lowercase and use hyphens and nothing else.

@Erin-Cecele
Copy link
Collaborator Author

well ... now that I think of it, citation id's do have spaces in them. I tested numbers, underscores, and periods but I guess I didn't test spaces within figure ids. Is there any reason a space would work in a citation id versus a figure id? Or is your point more that we should keep the messaging uniform across id types regardless?

@Erin-Cecele
Copy link
Collaborator Author

@geealbers per our meeting this morning, can I merge this? I opened two additional issues to keep track of the work not yet done: #715 and #716.

Copy link
Member

@geealbers geealbers left a comment

Choose a reason for hiding this comment

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

Yes, good to merge

@Erin-Cecele Erin-Cecele merged commit 939ffe8 into main Dec 12, 2023
@Erin-Cecele Erin-Cecele deleted the edit/add-update-figure-ids branch December 12, 2023 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants