Rationale/spec improvements #33
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
mgorny
requested review from
DEKHTIARJonathan,
emmatyping-nv,
konstin and
rgommers
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
27 tasks
rgommers
reviewed
Dec 30, 2025
| Rationale | ||
| ========= | ||
|
|
||
| Summary of changes |
There was a problem hiding this comment.
Was this duplicate, or incomplete? It seems pretty useful to have a concise summary of changes to guide the reader.
Author
There was a problem hiding this comment.
It was duplicate to the TOC, and it was pretty arbitrary to begin with. Like, it didn't really focus on what the spec is about, but rather on what you could easily bullet point.
Author
There was a problem hiding this comment.
Oh, and the "Overview" section now serves the same purpose. It's a little more verbose, but I think it explains the links better than a list.
There was a problem hiding this comment.
Okay, seems reasonable. I'll leave the comment open, since others may have the same question.
Co-authored-by: Ralf Gommers <ralf.gommers@gmail.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Signed-off-by: Michał Górny <mgorny@quansight.com>
Environment marker usage and optionality is described in "Providers" section. Let's limit "Provider information" only to technical field details themselves. Signed-off-by: Michał Górny <mgorny@quansight.com>
rgommers
approved these changes
Jan 2, 2026
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.
Per the feedback, try to make a better split of rationale/specification.
Notably, at this point Rationale tries to introduce all the important concepts, so it's mostly standalone. After reading it, one should have an idea of all the important concepts, and need Specification only to learn the details of how to implement them.
I've also noticed we're not really covering the use of providers in sufficient detail in the specification section, so expanded on the appropriate MUSTs and SHOULDs.
Potential TODO: we may also want to mention environment markers and ABI namespace in Rationale.