glen/dyna3
1
0
Fork 0
Code Issues 11 Pull Requests 1 Actions Projects Releases 2 Wiki Activity

Turn non-automated tests into Cargo examples #24

Open
Vectornaut wants to merge 5 commits from cargo-examples_on_main into main
pull from: cargo-examples_on_main
merge into: glen:main
Conversation 0 Commits 5 Files Changed 7 +191 -175
Vectornaut commented 2024-11-22 04:39:33 +00:00
Collaborator
Copy Link

Some of the Cargo tests on the main branch are designed to print output for human inspection, not to verify computations automatically. The incoming branch turns these tests into Cargo examples. It also makes two organizational changes in pursuit of this goal:

  • It introduces a dyna3 library target, which the examples use as a dependency. In the future, this target could grow into an officially maintained dyna3 library.
  • It puts the code for realizing the Irisawa hexlet into a new conditionally compiled engine::irisawa module. This code is shared by a test and an example. Compilation is controlled by the dev feature, which is turned on by default in development mode.

I've verified that printed output of the examples hasn't changed between the head (848f7d6) and base (e917272) of the incoming branch.

Some of the Cargo tests on the main branch are designed to print output for human inspection, not to verify computations automatically. The incoming branch turns these tests into Cargo examples. It also makes two organizational changes in pursuit of this goal: - It introduces a dyna3 library target, which the examples use as a dependency. In the future, this target could grow into an officially maintained dyna3 library. - It puts the code for realizing the Irisawa hexlet into a new conditionally compiled `engine::irisawa` module. This code is shared by a test and an example. Compilation is controlled by the `dev` feature, which is turned on by default in development mode. I've verified that printed output of the examples hasn't changed between the head (848f7d6) and base (e917272) of the incoming branch.
Vectornaut added 5 commits 2024-11-22 04:39:33 +00:00 
Put shared code in the conditionally compiled `engine::irisawa` module.
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin cargo-examples_on_main:cargo-examples_on_main
git checkout cargo-examples_on_main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
bug

Something is not working

  
duplicate

This issue or pull request already exists

  
enhancement

New feature

  
question

More information is needed

  
todo

Planned step in implementation

  
wontfix

This won't be fixed

No Label
bug
duplicate
enhancement
question
todo
wontfix
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: glen/dyna3#24
No description provided.
Delete Branch "cargo-examples_on_main"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?