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

Pointreg docs keywords. #5580

Merged
merged 9 commits into from
Aug 9, 2024
Merged

Conversation

jrcain-usgs
Copy link
Contributor

@jrcain-usgs jrcain-usgs commented Aug 9, 2024

Description

Updated Pointreg examples with new keyword, and related descriptions and screenshots.

Related Issue

Fixes #5343 - pointreg examples use old keywords

How Has This Been Validated?

  • Successfully ran each pointreg example with new keywords.
  • Built docs locally.
  • Content of changes should be validated by review.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation change (update to the documentation; no code change)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Infrastructure change (changes to things like CI or the build system that do not impact users)

Checklist:

  • I have read and agree to abide by the Code of Conduct
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have added myself to the .zenodo.json document.
  • I have added my user impacting change to the CHANGELOG.md document.

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

@jrcain-usgs jrcain-usgs self-assigned this Aug 9, 2024
Copy link

github-actions bot commented Aug 9, 2024

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5580".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@amystamile-usgs
Copy link
Contributor

Not sure if you did this already but a way to test your docs locally is to run ninja docs in your isis environment.

@jrcain-usgs
Copy link
Contributor Author

jrcain-usgs commented Aug 9, 2024

Not sure if you did this already but a way to test your docs locally is to run ninja docs in your isis environment.

I didn't know that, thanks! I tried it just now. Luckily no big surprises, but I did catch one typo after seeing it on the page.

Copy link

github-actions bot commented Aug 9, 2024

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5580".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

Copy link

github-actions bot commented Aug 9, 2024

The build and test suite have started for your pull request.

To view your build log, please reference the build with source version: "PR_5580".

Additionally, check the latest "dev" source version to identify existing test failures. Please note that you are not responsible for the test failures that exist on both your PR and the dev branch.

@jrcain-usgs jrcain-usgs merged commit 96381e8 into DOI-USGS:dev Aug 9, 2024
2 checks passed
@jrcain-usgs jrcain-usgs deleted the pointreg-docs-keywds branch August 9, 2024 21:26
@github-actions github-actions bot added documentation inactive Issue that has been inactive for at least 6 months labels Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation inactive Issue that has been inactive for at least 6 months
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pointreg examples use old keywords
2 participants