-
-
Notifications
You must be signed in to change notification settings - Fork 580
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
[docs] Fix up ExecRaw spellcheck trouble #4744
Conversation
@@ -218,11 +218,11 @@ If your container command should run from the directory you are running the comm | |||
|
|||
Example: `## HostWorkingDir: true` | |||
|
|||
### “ExecRaw” Annotation (Container Commands Only) | |||
### `ExecRaw` Annotation (Container Commands Only) |
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.
@rfay This fixes the spell check issue to the detriment of the reader by not following the format of the page. I’d either wrap all the heading annotations in backticks (“HostWorkingDir” Annotation
→
, etc.), or add “ExecRaw” to the exclusion list.HostWorkingDir
Annotation
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.
I don't think ExecRaw
should be in the spellcheck list because it's not a word.
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.
These aren’t words either:
ProjectTypes
OSTypes
HostBinaryExists
DBTypes
HostWorkingDir
But they’re quoted in headings on this page, just as ExecRaw
was. I’m saying that if you’re changing the heading format to appease the spell checker, you might as well update the format for the rest of them so you’re not signaling to the reader that ExecRaw
is somehow different. (Unless this is intentional and meaningful break in format and I’m missing the point.)
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.
Hmm, so I probably added all those to spellcheck huh? In that case I'll just do that.
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.
Sure, or use backticks for the rest of the headings.
I’d either wrap all the heading annotations in backticks (
“HostWorkingDir” Annotation
→, etc.), or add “ExecRaw” to the exclusion list.
HostWorkingDir
Annotation
I’m not sure how else to say this; whatever the answer, I think the reader that should matter more than the spell checker. The consistency of the page is for the reader.
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.
Fixed in #4746, you don't need to say it any more :)
The Issue
ExecRaw started causing spellcheck trouble. I probably pulled something when tests hadn't finished.