You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Lint the descriptions. We already check spelling, but ensure that there are no decorative quotes (see Fix quotes in descriptions. #402). No text that says "Default is blah", instead use a default: field. Consistently capitalize sentences and add periods at the end. Have the same tense.
Lint the descriptions of tests.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem?
I think we will end up generating documentation from spec into https://github.com/opensearch-project/documentation-website. That site has a lot of inconsistencies around wording, defaults, or quoting. See opensearch-project/documentation-website#7660 for an example.
What solution would you like?
description:
field for all structures.default:
field. Consistently capitalize sentences and add periods at the end. Have the same tense.The text was updated successfully, but these errors were encountered: