Skip to content
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

Add triage notes about redistributors #10914

Merged
merged 2 commits into from
Apr 8, 2022
Merged

Conversation

pradyunsg
Copy link
Member

x-ref: #9677

@pradyunsg pradyunsg added type: docs Documentation related skip news Does not need a NEWS file entry (eg: trivial changes) labels Feb 18, 2022
@stefanor
Copy link
Contributor

👍 for the Debian and Ubuntu wording.

Copy link
Member

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pradyunsg, the text looks like Markdown, but it should be ReStructuredText 😄. Excluding that, I give this PR a +1.

@uranusjr
Copy link
Member

The Markdown is in a code block that’s supposed to be copied into a GitHub issue. So the syntax is correct here, I think.

@uranusjr
Copy link
Member

The rst-backticks check needs be made smarter to ignore single ticks in a code block.

Copy link
Member

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Markdown is in a code block that’s supposed to be copied into a GitHub issue. So the syntax is correct here, I think.

If so, we can merge this now :)

The rst-backticks check needs be made smarter to ignore single ticks in a code block.

I'll send an issue to pre-commit/pygrep-hooks.

@DiddiLeija
Copy link
Member

I'll send an issue to pre-commit/pygrep-hooks.

See pre-commit/pygrep-hooks#95. Thinking a bit more about this, can development/issue-triage.rst become a Markdown file, such as development/issue-triage.md? This should resolve the CI checks for now.

@uranusjr
Copy link
Member

Or we can just use double backticks in Markdown 😉 Markdown is permissive regarding inline code, it works as long as the opening and ending numbers match.

Copy link
Member

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or we can just use double backticks in Markdown 😉 Markdown is permissive regarding inline code, it works as long as the opening and ending numbers match.

@pradyunsg Can we try this to avoid CI failures in future PRs?

docs/html/development/issue-triage.rst Outdated Show resolved Hide resolved
docs/html/development/issue-triage.rst Outdated Show resolved Hide resolved
pradyunsg and others added 2 commits April 8, 2022 12:53
This avoids the weird linter issues we're having here.
@pradyunsg pradyunsg force-pushed the distributor-notes branch from a65164b to 79ef8f3 Compare April 8, 2022 11:56
@pradyunsg
Copy link
Member Author

Thinking a bit more about this, can development/issue-triage.rst become a Markdown file, such as development/issue-triage.md?

I've done this. I wanna move the entire documentation to Markdown wherever possible anyway. :)

@pradyunsg
Copy link
Member Author

Merging this, since I imagine this is fairly non-controversial. If there's concerns on this, holler here! :)

@pradyunsg pradyunsg merged commit d5e1eee into pypa:main Apr 8, 2022
@pradyunsg pradyunsg deleted the distributor-notes branch April 8, 2022 12:09
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
skip news Does not need a NEWS file entry (eg: trivial changes) type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants