ExportXMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: Infrastructure
    • None
    • Python Drivers
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      Context

      PYTHON-6263 removes the blacken-docs pre-commit hook. Ruff can format Python code blocks in markdown files and code inside docstrings via docstring-code-format, but its edits are not equivalent to blacken-docs: it deletes bare ... doctest continuation markers, adds blank lines inside doctest examples, and normalizes quote style in rendered examples.

      Definition of done

      Enable markdown and docstring code formatting in pyproject, apply the one-time ruff format changes, and land with the doctest job green and the resulting example diffs reviewed.

      Pitfalls

      The doctest job executes docstring examples, so marker and blank-line changes can break it. Markdown formatting rewrites README, CONTRIBUTING, and CODING-STANDARDS.

            Assignee:
            Iris Ho
            Reporter:
            Alex Clark
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: