Draft
Conversation
Contributor
|
I'm not sure about this as it makes the plain markdown much less readable |
Contributor
Author
|
@swalkinshaw I wonder if a bit of formatting could improve that. So, instead of: *<a href="#user-content-use-weaker-types-in-complex-cases"
id="user-content-use-weaker-types-in-complex-cases">Rule:</a> Use weaker types
for inputs (e.g. `String` instead of `Email`) when the format is unambiguous and
client-side validation is complex. This lets the server run all non-trivial
validations at once and return the errors in a single place in a single format,
simplifying the client.*It could be: *<a href="#user-content-use-weaker-types-in-complex-cases" id="user-content-use-weaker-types-in-complex-cases">Rule:</a>
Use weaker types for inputs (e.g. `String` instead of `Email`) when the format
is unambiguous and client-side validation is complex. This lets the server run
all non-trivial validations at once and return the errors in a single place in a
single format, simplifying the client.* |
Contributor
Author
|
Alternatively, the rule numbers can just be dropped, without adding the permalinks. |
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
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.

Depends on #48.
#48 and similar changes break rule references. After #48, docs that refer to "rule 22 of the GraphQL design tutorial" will be referring to the wrong rule. This change aims to future-proof the rules by providing permalinks, making reference more stable.
GitHub requires that IDs start with
user-contentfor whatever reason.