-
Notifications
You must be signed in to change notification settings - Fork 3
run stylecheck #191
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
run stylecheck #191
Conversation
Published docs preview URL: https://devrev-preview-ae5b182e-242f-40d8-8054-3fa1fe8b2e0f.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-c9134063-8e72-4ea0-8ad9-df669ee80586.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-d71d6f8a-c689-477f-8eae-cec381cbe8b6.docs.buildwithfern.com |
…api-docs into bc/check-ISS-157878
style/style-common.md
Outdated
- If the item consists of a single word, don't add end punctuation. | ||
- If the item doesn't include a verb, don't add end punctuation. | ||
- If the item is entirely in code font, don't add end punctuation. | ||
- If the item is entirely link text or a document title, don't add end punctuation. | ||
- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. No newline at end of file | ||
- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. |
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 the item consists of a single word, don't add end punctuation. | |
- If the item doesn't include a verb, don't add end punctuation. | |
- If the item is entirely in code font, don't add end punctuation. | |
- If the item is entirely link text or a document title, don't add end punctuation. | |
- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. | |
\ No newline at end of file | |
- Titles of instructions or how-to guides should be a verb in the infinitive form without “to”, not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. | |
- If the item consists of a single word, don't add end punctuation | |
- If the item doesn't include a verb, don't add end punctuation | |
- If the item is entirely in code font, don't add end punctuation | |
- If the item is entirely link text or a document title, don't add end punctuation | |
- Titles of instructions or how-to guides should be a verb in the infinitive form without "to", not a gerund (ending in -ing). Titles of any other type of section should be noun phrases. |
✨ Comment from AI reviewer ✨ Since this appears to be the style guide itself, there are relatively few issues to fix. However, I noticed a few items that could be improved for consistency with the rules:
I made suggestions where possible but couldn't add them everywhere. My complete revision is below. Full text
|
Published docs preview URL: https://devrev-preview-ca16e3a5-519d-4c9b-ad6e-b6155ecca1f0.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-56138f6c-b534-43d6-bd6c-9d8fb7f75a06.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-6fd5c8c2-d716-49d4-815e-41c1a57537d6.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-3f14609b-0499-4d98-947a-a280991e0165.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-375e863c-c3ed-4396-bf75-d8c2d0a21f48.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-2f8f3f28-548b-4379-9c08-bcf81a12e0ab.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-5f9d4eaf-9835-45df-8454-16bbc459ef99.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-1d96e20d-6e12-4a57-8ead-66d79323391d.docs.buildwithfern.com |
No description provided.