eslint-doc-generator may produce incorrect results on Windows #265
Description
Issue
The CONTRIBUTING > Document generation document describes using ESLint eslint-doc-generator to generate consistent documentation.
The current latest version [email protected] has issues when run on Windows:
- Text incorrectly deleted on Windows after Prettier runs bmish/eslint-doc-generator#725
- Inserted tables have mixed LF/CRLF line endings bmish/eslint-doc-generator#726
Edit: issues remain using version [email protected]
Suggestion
- Monitor the resolution of the above issues
- Avoid running eslint-doc-generator on Windows and use Linux or macOS if possible
- If this is a long-term or permanent restriction, then add this information to the CONTRIBUTING > Document generation document