-
Notifications
You must be signed in to change notification settings - Fork 28
style: lint markdown files #118
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
Conversation
@jaimergp @conda/steering-council please take a look and let me know what you think! |
All changes to previous CEPs are cosmetic 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.
Thanks Matt! 🙏
Looks like there are some good fixes in here
Had some questions about some changes, which I didn't quite follow
* [Default programs in Windows](https://learn.microsoft.com/en-us/windows/win32/shell/default-programs) | ||
- [Rework linux/osx support plus new simplified format?](https://github.com/conda/menuinst/issues/48) |
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.
Why is using *
for lists unacceptable? Both are valid list formats
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.
The linter requires that if you start with a given symbol, you have to use the same one all the way through the document.
``` | ||
```bash |
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.
Do we always need a language type for code blocks? Sometimes GitHub lacks an appropriate language type for particular code
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.
Yes. Marking text is fine.
- `noarch` | ||
* `weak` |
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.
Do we know why *
or -
is preferred? Seems we are switching some to one or the other, but without a clear reason
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.
See my comment above. Use the same symbol everywhere and you will be fine.
- For any other types, error out. | ||
- For regular files: |
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.
How is linter indentation configured?
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 know of setting that sets this.
Checklist for submitter
cep-0000.md
namedcep-XXXX.md
in the root level.All modifications are for style.