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

Docs: Preprocessor for Python < 3.12 #926

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

Lorak-mmk
Copy link
Collaborator

@Lorak-mmk Lorak-mmk commented Feb 2, 2024

Preprocessor script was using syntax that works with Python 3.12 but not with older version.
Namely, string in format string using the same delimiter as outer string. Example: f'abc{'def'}xyz'

This commit changes delimiters of inner string to make script compatible with older versions of Python.

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

Preprocessor script was using syntax that works with Python 3.12 but
not with older version.
Namely, string in format string using the same delimiter as
outer string. Example: f'abc{'def'}xyz'

This commit changes delimiters of inner string to make script
compatible with older versions of Python.
@Lorak-mmk Lorak-mmk requested a review from piodul February 2, 2024 00:56
@piodul
Copy link
Collaborator

piodul commented Feb 2, 2024

Preprocessor script was using syntax that works with Python 3.12 but not with older version.

Why did the CI checks pass in the PR that introduced it, then? #910

As a side not, please also make sure to tick off the relevant boxes in the "Pre-review checklist". They are not optional for the maintainers.

@piodul piodul mentioned this pull request Feb 2, 2024
8 tasks
@Lorak-mmk
Copy link
Collaborator Author

Preprocessor script was using syntax that works with Python 3.12 but not with older version.

Why did the CI checks pass in the PR that introduced it, then? #910

Preprocessor crash is not a hard error for documentation building - it will just build using unmodified sources.

@piodul
Copy link
Collaborator

piodul commented Feb 2, 2024

Preprocessor script was using syntax that works with Python 3.12 but not with older version.

Why did the CI checks pass in the PR that introduced it, then? #910

Preprocessor crash is not a hard error for documentation building - it will just build using unmodified sources.

Yeah, looks like it, and it is already reported as a bug: rust-lang/mdBook#1872

@piodul piodul merged commit e3ae2cd into scylladb:main Feb 2, 2024
9 checks passed
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.

2 participants