Skip to content

Merging changes made to documentation and basic test scripts - #46

Merged
sayanmitracode merged 17 commits into
mainfrom
docs
May 7, 2026
Merged

Merging changes made to documentation and basic test scripts#46
sayanmitracode merged 17 commits into
mainfrom
docs

Conversation

@AlexYFM

@AlexYFM AlexYFM commented Apr 22, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@AlexYFM

AlexYFM commented Apr 22, 2026

Copy link
Copy Markdown
Collaborator Author

Two main changes: added additional documentation so that each main page had some content (note: would still like to improve the added documentation, but for now, just make sure page isn't blank and offers some guidance).

To that end, I've attached the following snippets of what the new docs look like (compiled from map.rst, outputs.rst, sensor.rst, and plotting.rst):

maps docs outline added reachtube section to outputs.rst sensor docs outline image

Aside from the documentation changes, I've made some light automated testing changes: now functional.yml will run test_reach, which currently only tests to make sure that current Verse verifies the same reachtube trace as a given saved trace (done using some existing utility functions like trace.dump() and some new ones that can be found in tests/test_utils.py). Note that future demo tests can be done using the same format.

Finally, I've made pylint.yml run only on manual trigger given that it almost always returned fail with far too many error messages.

@sayanmitracode
sayanmitracode merged commit 8fdc938 into main May 7, 2026
4 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.

2 participants