Fix documentation formatting issues#158
Merged
Merged
Conversation
- README: add blank lines before markdown list items in "deeper integration" section so they render as proper lists; fix "collegue" typo. - CONTRIBUTING: expand developer setup with step-by-step instructions for installing Rust and building the native maturin extension, adapted from the ci.yml workflow. - xarray_sql/df.py: replace Sphinx-style :func: cross-reference with plain backtick syntax understood by mkdocstrings. - xarray_sql/reader.py: convert non-standard "Filter Pushdown:" section to a proper Google-style Note: section; remove spurious backslash escapes before double-quotes in the embedded SQL example. https://claude.ai/code/session_01TVBHrvmi2vxMJxpLt3U1vB
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
integration" section so they render as proper lists; fix "collegue"
typo.
for installing Rust and building the native maturin extension, adapted
from the ci.yml workflow.
plain backtick syntax understood by mkdocstrings.
to a proper Google-style Note: section; remove spurious backslash
escapes before double-quotes in the embedded SQL example.
https://claude.ai/code/session_01TVBHrvmi2vxMJxpLt3U1vB