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

Docs: Update stand-alone test information #44755

Merged
merged 5 commits into from
Jun 25, 2024

Conversation

tldahlgren
Copy link
Contributor

@tldahlgren tldahlgren commented Jun 18, 2024

This PR updates the stand-alone test documentation to improve the examples, emphasize points I find myself making during PR reviews, and provide tips that I think have been useful in my work with others.

  • split test parts into separate section for emphasis and an includable link for PRs
  • elaborate on and provide a more relevant example of building and running tests
  • update, improve, and add examples of stand-alone tests (based on "common" PR feedback I've given)
  • Add references (and links) to relevant sections to help people find the information they need
  • update the test log's descriptions and status of tests to align with current outputs
  • make better use of alternative admonitions for titles and or alternate colors

@spackbot-app spackbot-app bot added core PR affects Spack core functionality documentation Improvements or additions to documentation stand-alone-tests Stand-alone (or smoke) tests for installed packages labels Jun 18, 2024
@tldahlgren tldahlgren marked this pull request as ready for review June 20, 2024 02:09
Copy link
Member

@alalazo alalazo left a comment

Choose a reason for hiding this comment

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

@alalazo alalazo self-assigned this Jun 20, 2024
@tldahlgren
Copy link
Contributor Author

Docs not building: https://readthedocs.org/projects/spack/builds/24752925/

Had a useful error message too. Those literal end-strings...

@tldahlgren
Copy link
Contributor Author

tldahlgren commented Jun 24, 2024

This PR is hung on CI but it is a docs-only change making that check irrelevant.

Copy link
Member

@alalazo alalazo left a comment

Choose a reason for hiding this comment

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

I did a quick pass over docs, and it lgtm. Feel free to merge if you're not seeking further comments / opinions.

@tldahlgren tldahlgren merged commit baf82c0 into spack:develop Jun 25, 2024
34 checks passed
@tldahlgren tldahlgren deleted the docs_clarify_test_parts branch June 25, 2024 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core PR affects Spack core functionality documentation Improvements or additions to documentation stand-alone-tests Stand-alone (or smoke) tests for installed packages
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants