refactor documentation of operators, document + for strings and paths
#7498
Conversation
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/tweag-nix-dev-update-42/24204/1 |
|
I'm not convinced that this format is better for readers than a table. Whether the table is less maintainable is not super important given that we rarely ever add operators. For comparison, the Rust language reference also uses a table: https://doc.rust-lang.org/book/appendix-02-operators.html |
this is for a simpler transformation into a series of subsections
this form is much easier to maintain (also with minimal diffs), and allows for more details on each operator. this change a purely mechanical transformation, without changing any contents.
add notes on semantics where appropriate
this makes the table less unwieldy, and leaves enough space for extensive explanations.
fricklerhandwerk
force-pushed
the
path+string
branch
from
d1e2575
to
e57165b
Compare
|
@edolstra now this is closer to how it's done in the Rust docs. I added explanations in external notes, such that the table is narrower and we still have enough space to add explanations where needed. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/nix-team-report-2022-10-2023-03/27486/1 |
move annotations out of the column
this form is easier to maintain, displays better because it needs less space, and allows
for more details on each operator that requires explanations.
document semantics of overloaded
+operatorRelated: #7338 (comment)
This work is sponsored by Antithesis ✨