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

TST: update path consistency, adjust documentation #391

Merged
merged 3 commits into from
Nov 1, 2024

Conversation

tangkong
Copy link
Contributor

Description

  • fixes a quick bug that manifests depending on where you run pytest.
    • pytest is meant to be run from the repository root, but can also run from inside the test folder.
    • test_create_arg expected pytest to be invoked from the repository root, and would fail if run from elsewhere
    • we should still advocate for running from the repository root, but it doesn't hurt to be less fragile
  • includes an ascii map for the mock beamline defined in happi_db.json.
    • Included this in the conf.yaml because json doesn't support comments
  • Fixes some stray formatting errors in the github.io docs

Motivation and Context

Uncovered while helping Jane debug some unit tests.

How Has This Been Tested?

By ensuring the test suite still works

Where Has This Been Documented?

This PR

Pre-merge checklist

  • Code works interactively (a real hutch config file can be loaded)
  • Code contains descriptive docstrings, including context and API
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions
  • Ran docs/pre-release-notes.sh and created a pre-release documentation page
  • Pre-release docs include context, functional descriptions, and contributors as appropriate

@janeliu-slac
Copy link
Contributor

Looks good to me.

@tangkong tangkong merged commit 3e22a18 into pcdshub:master Nov 1, 2024
11 checks passed
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