-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
[Components][Console] Replace ambiguous heading to generate unique anchor #3131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I don't see what problem we have when removing the headings? |
@@ -123,8 +123,8 @@ in the last argument. Using ``false`` means the amount of attempts is infinite. | |||
The user will be asked as long as he provides an invalid answer and will only | |||
be able to proceed if her input is valid. | |||
|
|||
Hiding the User's Response | |||
~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
Validating a hidden Response |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Validating a Hidden Response
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thought about this one, but when looking at e.g.
- Asking the User for confirmation
- Asking the User for Information
- Testing a Command which expects input
I wasn't sure what to capitalize ;-)
If we rename I can update this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Asking the User for Confirmation
- Testing a Command which Expects Input
is what I'd say
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should write this standard 👶
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The standard, iirc (which Fabien explained to me long long ago) is to capitalize nouns and adjectives, but not verbs. So, Validating a Hidden Response
would be correct. Two examples:
I've opened up a PR #3149 to clarify these.
So after that, are we happy with the header names here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@xabbuh expects
lower case
Testing a Command which expects Input
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@weaverryan copied chief 👶
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're happy I would update to uppercase "Hidden" 😃
Because the description under the first heading would then be on the same level as Autocompletion? |
[Components][Console] Replace ambiguous heading to generate unique anchor
Removing both headings would cause some side effects in the document structure I think; so I tried to find a good replacement for the second heading.