Docs problem creation #160
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I added some more things and reshuffled the file structure a bit. This now includes details on custom I/O formatting, using type annotations, and some other advanced features. Note that this PR now is dependent on #161. |
|
Thank you very much for these additional changes and many additions, this goes well beyond what I set out to document. I like the restructuring that you did, the separation between student and instructor material, as well as additional content, is now much clearer. From my point of view this branch is ready to merge. I would also vote for creating a new minor release afterwards. |
…le into docs_problem_creation
|
yeah that looks good. I've made another PR, #162, that I'd also include in the new release. |
ImogenBits
approved these changes
Jan 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation for creating problems. It discusses the basic interaction between the algobattle framework and problem files and walks the reader through the creation of a concrete, new problem.
Still missing and only added as a stub in this PR is the discussion on using alternative I/O formats other than JSON. I am not familiar enough with the framework to have the authority to discuss this topic, but deem it important that this should be discussed in this context. Please do not merge this PR until this is resolved.