8000 style: lint markdown files by beckermr · Pull Request #118 · conda/ceps · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

Merged
merged 9 commits into from
Mar 15, 2025
Merged

style: lint markdown files #118

merged 9 commits into from
Mar 15, 2025

Conversation

beckermr
Copy link
Contributor
@beckermr beckermr commented Mar 14, 2025

Checklist for submitter

  • I am submitting a new CEP: Put your title here.
    • I am using the CEP template by creating a copy cep-0000.md named cep-XXXX.md in the root level.
  • I am submitting modifications to CEP 1, 3, 4, 6, 8, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20
  • Something else: I am adding linting for markdown files.

All modifications are for style.

@beckermr beckermr marked this pull request as ready for review March 14, 2025 20:23
@beckermr
Copy link
Contributor Author

@jaimergp @conda/steering-council please take a look and let me know what you think!

@beckermr
Copy link
Contributor Author

All changes to previous CEPs are cosmetic only.

@beckermr beckermr merged commit a60cf5f into main Mar 15, 2025
1 check passed
@beckermr beckermr deleted the beckermr-patch-2 branch March 15, 2025 15:56
Copy link
Member
@jakirkham jakirkham left a 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

Comment on lines -244 to +236
* [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)
Copy link
Member

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

Copy link
Contributor Author

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.

Comment on lines -208 to +203
```
```bash
Copy link
Member

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

Copy link
Contributor Author

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.

Comment on lines -59 to +55
- `noarch`
* `weak`
Copy link
Member

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

Copy link
Contributor Author

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.

Comment on lines -34 to +29
- For any other types, error out.
- For regular files:
Copy link
Member

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?

Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0