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

build: added alt text to cover page's US Dept of Commerce seal #68

Merged
merged 2 commits into from
Nov 4, 2024

Conversation

sbreitbart-NOAA
Copy link
Collaborator

What is the feature?

  • Added alt text to cover page's US Dept of Commerce seal

How have you implemented the solution?

  • Writing a line of LaTeX

Does the PR impact any other area of the project, maybe another repo?

  • No

Copy link
Contributor

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@@ -107,7 +107,7 @@
\vspace{1\baselineskip}

%%%%%% Tagline at bottom
\includegraphics[width=2cm]{support_files/us_doc_logo.png}\newline
\pdftooltip{\includegraphics[width=2cm]{support_files/us_doc_logo.png}}{Seal of the United States Department of Commerce}\newline
Copy link
Collaborator

Choose a reason for hiding this comment

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

I am not sure why you are using pdftooltip here when you can just add the alternative text to the call to includegraphics. Also, the seal is an artifact rather than an actual figure in my opinion and you can tag it as such so that no alternative text is needed. From W3 artifacts are "generally graphics objects or other markings that are not part of the authored content. Examples of artifacts include page header or footer information, lines or other graphics separating sections of the page, or decorative images."

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hi Kelli- thanks for your review. My responses:

I am not sure why you are using pdftooltip here when you can just add the alternative text to the call to includegraphics.

  • This mistake was because I'm so new to LaTeX and was trying to implement a solution I saw on StackOverflow. Thanks for sharing the better way to do that.

Also, the seal is an artifact rather than an actual figure in my opinion and you can tag it as such so that no alternative text is needed. From W3 artifacts are "generally graphics objects or other markings that are not part of the authored content. Examples of artifacts include page header or footer information, lines or other graphics separating sections of the page, or decorative images."

  • Thanks for letting me know. I agree that the seal is, in fact, in artifact. My next commit will include the .tex file with the alt text removed and the artifact tag added.

@sbreitbart-NOAA sbreitbart-NOAA merged commit 0680e4c into dev Nov 4, 2024
8 checks passed
@sbreitbart-NOAA sbreitbart-NOAA deleted the alt-text-noaa-logo branch November 4, 2024 20:58
@sbreitbart-NOAA sbreitbart-NOAA restored the alt-text-noaa-logo branch November 12, 2024 17:02
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.

3 participants