fix/first release cleanup #17
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
- fix formatting and add placeholders for missing docs - add an action to check that docs.rs will build correctly Signed-off-by: mimir-d <[email protected]>
- for consistency with diagnosis macros Signed-off-by: mimir-d <[email protected]>
- at some cost for semantics, overload the meaning of an empty map to be Option::None. This however removes a bunch of boilerplate code all over the place - arguably, this can be fully avoided by not using Option in spec.rs, but in that case, it's clearer to match the Option with the non-mandatory in the spec in an 1:1 fashion Signed-off-by: mimir-d <[email protected]>
- this should make it easier to discover breakages before github gets to run the same commands; this script is relatively stable, but should be updated if the gh actions are changed Signed-off-by: mimir-d <[email protected]>
- no functional changes Signed-off-by: mimir-d <[email protected]>
- remove ref requirement for some objects that are frequently consumed, without any need to keep additional objects around (or if so, they're Clone) - remove a bunch of unnecessary `.clone()` Signed-off-by: mimir-d <[email protected]>
- this simplifies the api by providing a single way to make builders Signed-off-by: mimir-d <[email protected]>
- this was missing from a publicly exported DiagnosisType, which means that it risks breaking crate api if changed - for safety reasons, just make all the enums (private or public) non_exhaustive Signed-off-by: mimir-d <[email protected]>
- a bit less verbose - diagnosis was missing a verb Signed-off-by: mimir-d <[email protected]>
njordr
approved these changes
Oct 11, 2024
- fixed all merge conflicts - separate file.rs tests - renamed new file methods to have verbs Signed-off-by: mimir-d <[email protected]>
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.
Option::None. This however removes a bunch of boilerplate code all
over the place
but in that case, it's clearer to match the Option with the
non-mandatory in the spec in an 1:1 fashion
without any need to keep additional objects around (or if so, they're
Clone)
.clone()