Skip to content

Fix PEP References#656

Merged
freakboy3742 merged 1 commit into
beeware:lektorfrom
johnzhou721:patch-10
Jun 10, 2025
Merged

Fix PEP References#656
freakboy3742 merged 1 commit into
beeware:lektorfrom
johnzhou721:patch-10

Conversation

@johnzhou721
Copy link
Copy Markdown
Contributor

We've marked down the importance of RST, but as a side effect, those links gets converted to code blocks and we lose some automation for PEP linking AFAIK. I am not sure if there's a more automated way.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@johnzhou721 johnzhou721 marked this pull request as ready for review June 10, 2025 00:27
Copy link
Copy Markdown
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

This is an artefact of the automated transformation from RST to MD; I'm sure there are others. If you can find an automated way to identify them, great; otherwise, we can fix them as we find them.

@freakboy3742 freakboy3742 merged commit 8542162 into beeware:lektor Jun 10, 2025
@johnzhou721
Copy link
Copy Markdown
Contributor Author

This is an artefact of the automated transformation from RST to MD; I'm sure there are others. If you can find an automated way to identify them, great; otherwise, we can fix them as we find them.

Todo for myself: Write script to scour previous git commit for the :pep:

@mhsmith
Copy link
Copy Markdown
Member

mhsmith commented Jun 10, 2025

Searching for the regular expression `[0-9]+` in the current repository, I can't find any other examples except for all the translations of the same things.

I'd also be interested in whether there were any other :keyword: constructs in the RST which the conversion has broken. Didn't it give a warning about keywords it didn't understand? Converting them all silently to code blocks seems like a poor solution.

@freakboy3742
Copy link
Copy Markdown
Member

I'd also be interested in whether there were any other :keyword: constructs in the RST which the conversion has broken. Didn't it give a warning about keywords it didn't understand? Converting them all silently to code blocks seems like a poor solution.

Agreed it's a poor solution; however, I'm not aware of any warnings that were raised during the conversion process.

@johnzhou721
Copy link
Copy Markdown
Contributor Author

I'd also be interested in whether there were any other :keyword: constructs in the RST which the conversion has broken. Didn't it give a warning about keywords it didn't understand? Converting them all silently to code blocks seems like a poor solution.

Agreed it's a poor solution; however, I'm not aware of any warnings that were raised during the conversion process.

Also:

Test\ *hi*\ Hi --> TesthiHi

got converted to

Test *hi* Hi --> Test hi Hi

Which is a problem for e.g. Chinese.

@freakboy3742
Copy link
Copy Markdown
Member

Which is a problem for e.g. Chinese.

Sure - it was an automated transform. We made the best effort we could to find problems that could be fixed in an automated fashion, but at some point, you have to accept that there are issues with an automated transform on that scale, and move on, fixing problems as you find them.

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