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

Fix for rendering of code blocks in CLE documentation #1159

Merged
merged 1 commit into from
May 19, 2023

Conversation

absurdfarce
Copy link
Collaborator

@absurdfarce absurdfarce commented May 18, 2023

Looks like I wasn't following rst as closely as I should've been.

Relevant notes on code block formatting can be found here.

…ks like rst wants

an empty line between the code-block declaration and the start of the sample code.
Copy link
Contributor

@jgillenwater jgillenwater left a comment

Choose a reason for hiding this comment

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

I left two comments that would make this structured like some of the codeblocks in other topics. Can we try this instead?

docs/column_encryption.rst Show resolved Hide resolved
docs/column_encryption.rst Show resolved Hide resolved
@absurdfarce
Copy link
Collaborator Author

absurdfarce commented May 19, 2023

Met with @jgillenwater to discuss and we settled on the Sphinx-specific code-block usage for now. Also filed PYTHON-1349 to come up with a more robust long-term answer for this across the entire set of Python driver docs.

@absurdfarce absurdfarce merged commit 0002e91 into master May 19, 2023
@absurdfarce absurdfarce deleted the cle_doc_updates branch May 19, 2023 17:25
fruch added a commit to fruch/python-driver that referenced this pull request Jun 6, 2024
…sync_with_upstream_3.29.1

version 3.28.0

* tag '3.28.0' of https://github.com/datastax/python-driver:
  Release 3.28.0: changelog & version
  PYTHON-1352 Add vector type, codec + support for parsing CQL type (datastax#1161)
  Update docs.yaml to point to most recent 3.27.0 docs changes
  CONN-38 Notes for 3.27.0 on PYTHON-1350 (datastax#1166)
  PYTHON-1356 Create session-specific protocol handlers to contain session-specific CLE policies (datastax#1165)
  PYTHON-1350 Store IV along with encrypted text when using column-level encryption (datastax#1160)
  PYTHON-1351 Convert cryptography to an optional dependency (datastax#1164)
  Jenkinsfile cleanup (datastax#1163)
  PYTHON-1343 Use Cython for smoke builds (datastax#1162)
  Don't fail when inserting UDTs with prepared queries with some missing fields (datastax#1151)
  Revert "remove unnecessary import __future__ (datastax#1156)"
  docs: convert print statement to function in docs (datastax#1157)
  remove unnecessary import __future__ (datastax#1156)
  Update docs.yaml to include recent fixes to CLE docs
  Fix for rendering of code blocks in CLE documentation (datastax#1159)
  DOC-3278 Update comment for retry policy (datastax#1158)
  DOC-2813 (datastax#1145)
  Remove different build matrix selection for develop branches (datastax#1138)
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 9, 2024
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 9, 2024
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 9, 2024
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 9, 2024
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 9, 2024
dkropachev pushed a commit to dkropachev/python-driver that referenced this pull request Aug 15, 2024
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