docs: set up guide #155
Open
docs: set up guide #155
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
camshaft
force-pushed
the
camshaft/guide
branch
from
dcb49e7 to
5ef9a29
Compare
camshaft
had a problem deploying
to
github-pages
GitHub Actions
Failure
camshaft
force-pushed
the
camshaft/guide
branch
3 times, most recently
from
d5d0e60 to
cca2e7a
Compare
| In a strongly-typed language, this requirement is being both implemented and tested by the compiler. | ||
|
|
||
| ```rust | ||
| //= my-spec.md#section |
There was a problem hiding this comment.
should this have //= type=implication?
guide/src/annotations.md
Outdated
| Implementations MAY panic on invalid arguments. | ||
| ``` | ||
|
|
||
| In our example here, we've chosen _not_ to panic, but instead return an error. Annotations with the `exception` type are expected to provide a reason as to why the requirement is not being implemented. |
There was a problem hiding this comment.
Annotations with the exception type are expected
I forget if "reason" is required for this, maybe make it clear one way or the other if its optional or required
camshaft
force-pushed
the
camshaft/guide
branch
from
cca2e7a to
b698dc0
Compare
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.
Description of changes:
This change sets up a guide to describe some of the concepts in duvet and how to configure the workflow. While it's not exhaustive, it's a lot better than what we have no, which is nothing.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.