refactor: capitalize comments (#7188)

* refactor: capitalize comments

* revert...

packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts

@@ -849,7 +849,6 @@ describe('versioned site', () => {
     const {siteDir, context, options, version100} = await loadSite({
       options: {
         editUrl: 'https://github.com/facebook/docusaurus/edit/main/website',
-        // editCurrentVersion: true,
       },
     });
 

packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts

@@ -68,8 +68,8 @@ const createFakeActions = (contentDir: string) => {
     },
   };
 
-  // query by prefix, because files have a hash at the end
-  // so it's not convenient to query by full filename
+  // Query by prefix, because files have a hash at the end so it's not
+  // convenient to query by full filename
   const getCreatedDataByPrefix = (prefix: string) => {
     const entry = Object.entries(dataContainer).find(([key]) =>
       key.startsWith(prefix),

packages/docusaurus-plugin-content-docs/src/__tests__/numberPrefix.test.ts

@@ -23,7 +23,7 @@ const IgnoredNumberPrefixPatterns = [
   '00abc01-My Doc',
   'My 001- Doc',
   'My -001 Doc',
-  // ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
+  // Ignore common date-like patterns: https://github.com/facebook/docusaurus/issues/4640
   '2021-01-31 - Doc',
   '31-01-2021 - Doc',
   '2021_01_31 - Doc',
@@ -36,7 +36,7 @@ const IgnoredNumberPrefixPatterns = [
   '01-2021 - Doc',
   '01_2021 - Doc',
   '01.2021 - Doc',
-  // date patterns without suffix
+  // Date patterns without suffix
   '2021-01-31',
   '2021-01',
   '21-01-31',
@@ -49,7 +49,7 @@ const IgnoredNumberPrefixPatterns = [
   '01',
   '2021',
   '01',
-  // ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
+  // Ignore common versioning patterns: https://github.com/facebook/docusaurus/issues/4653
   '8.0',
   '8.0.0',
   '14.2.16',

packages/docusaurus-plugin-content-docs/src/__tests__/options.test.ts

@@ -15,7 +15,7 @@ import {
 import {GlobExcludeDefault} from '@docusaurus/utils';
 import type {Options} from '@docusaurus/plugin-content-docs';
 
-// the type of remark/rehype plugins is function
+// The type of remark/rehype plugins can be function/object
 const markdownPluginsFunctionStub = () => {};
 const markdownPluginsObjectStub = {};
 

packages/docusaurus-plugin-content-docs/src/__tests__/props.test.ts

@@ -57,7 +57,7 @@ describe('toTagDocListProp', () => {
       count: 2,
       label: tag.label,
       permalink: tag.permalink,
-      items: [doc3, doc1], // docs sorted by title, ignore "id5" absence
+      items: [doc3, doc1], // Docs sorted by title, ignore "id5" absence
     });
   });
 });