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: Fix code highlighting in third-party libraries integration guide #268

Merged
merged 6 commits into from
Feb 28, 2024

Conversation

AdrianoKF
Copy link
Contributor

@AdrianoKF AdrianoKF commented Feb 28, 2024

After a refactoring of the transactions feature, the code examples themselves were modied, but not the page that highlights some lines in them.

This PR updates those code blocks to make them consistent with the actual example code.

Additionally, it pins the Python version used for pre-commit hooks to 3.11, to prevent problems on systems with Python 3.12 (which would be used to lock dependencies using pip-compile, which includes the Python version number in a comment in the generated dependency lock file).

Closes #267

Copy link

codecov bot commented Feb 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.32%. Comparing base (bad9dd8) to head (4d07d8a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   94.32%   94.32%           
=======================================
  Files           5        5           
  Lines         388      388           
  Branches       72       72           
=======================================
  Hits          366      366           
  Misses         13       13           
  Partials        9        9           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

additional_dependencies: ["bandit[toml]"]
- id: bandit
args: [-c, pyproject.toml]
additional_dependencies: ["bandit[toml]"]
Copy link
Collaborator

@maxmynter maxmynter Feb 28, 2024

Choose a reason for hiding this comment

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

I agree with these indents here (and above). But Nicho noted them on another PR from me. Do we have a projet standard on these idents/formatting things?

Copy link
Contributor

Choose a reason for hiding this comment

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

The rest of the file uses this style of indentation. From a quick look we also use it in the other files.

AFAIK, we do not have a standard defined.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't, but at least each file should be consistent. FWIW, I consider whatever defaults the YAML plugin in VS Code has my standard (which is why the file got reformatted when I saved it).

@janwillemkl janwillemkl merged commit 4869a3c into main Feb 28, 2024
7 checks passed
@janwillemkl janwillemkl deleted the 267-docs-fixes branch February 28, 2024 14:27
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.

Docs: Code highlighting in Polars integration example is offset
3 participants