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

minor doc improvements/additions #204

Merged
merged 4 commits into from
Jun 21, 2024
Merged

Conversation

alessandrofelder
Copy link
Member

@alessandrofelder alessandrofelder commented Jun 17, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

What does this PR do?

  • specify that the atlasgen optional dependency is needed to contribute an atals
  • provides a sample script for visual inspection of atlas
  • minor clarifications in text
  • more in-depth validation documentation to be contributed in a separate PR.

References

Closes #203

How has this PR been tested?

CI, and proofreading by PR author.

Is this a breaking change?

No

Does this PR require an update to the documentation?

This is one.

Checklist:

  • [ \ ] The code has been tested locally
  • [ \ ] Tests have been added to cover all new functionality (unit & integration)
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

* specify atlasgen optional dependency
* provide sample script for visual inspection of atlas
* minor clarifications in text
@alessandrofelder alessandrofelder self-assigned this Jun 17, 2024
@alessandrofelder alessandrofelder marked this pull request as ready for review June 17, 2024 17:34
@alessandrofelder alessandrofelder requested a review from a team June 17, 2024 17:34
Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

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

LGTM, just a couple of small comments.

@alessandrofelder alessandrofelder merged commit 2d32836 into main Jun 21, 2024
2 checks passed
@alessandrofelder alessandrofelder deleted the improve-atlasgen-docs branch June 21, 2024 10:41
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.

[Feature] Update "how to contribute an atlas" in light of atlas generation dependencies being made optional.
2 participants