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: Minor improvements to contributing guide #18777

Merged
merged 3 commits into from
Sep 18, 2024

Conversation

rodrigogiraoserrao
Copy link
Collaborator

@rodrigogiraoserrao rodrigogiraoserrao commented Sep 16, 2024

This PR makes some minor improvements to the contributing guide, reflecting the experience I just had setting everything up.

  • Add two notes to things that are required when setting up the dev environment for the first time and when building the docs for the first time.
  • Fix formatting of a nested list that was being poorly formatted by dprint because it uses a different standard from the one followed by the markdown parser used by MkDocs.
  • Add a “copy to clipboard” button to all code snippets which is SUCH a quality of life improvement!

dprint uses two spaces when auto formatting the nested lists and the parser that MkDocs uses expects an indentation of at least 4 spaces or 1 tab (c.f. 'Indentation/tab length' at https://python-markdown.github.io/#differences), so we need to bypass dprint in order for the nested list to show properly.
@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars labels Sep 16, 2024
@rodrigogiraoserrao rodrigogiraoserrao marked this pull request as ready for review September 16, 2024 15:17
@ritchie46
Copy link
Member

Fix formatting of a nested list that was being poorly formatted by dprint because it uses a different standard from the one followed by the markdown parser used by MkDocs.

Will a next dprint call undo this again?

@ritchie46
Copy link
Member

Add a “copy to clipboard” button to all code snippets which is SUCH a quality of life improvement!

<3

@rodrigogiraoserrao
Copy link
Collaborator Author

Will a next dprint call undo this again?

Nope, because I used the <!-- dprint-ignore-start --> directive to prevent dprint from formatting that nested list.

@ritchie46 ritchie46 merged commit 1b5d6ec into pola-rs:main Sep 18, 2024
6 checks passed
@rodrigogiraoserrao rodrigogiraoserrao deleted the docs-contributing branch September 18, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Related to Python Polars rust Related to Rust Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants