Skip to content

docs: Fix docs check list items#340

Merged
Oliver Borchert (borchero) merged 3 commits into
mainfrom
fix-docs-check-list-items
May 15, 2026
Merged

docs: Fix docs check list items#340
Oliver Borchert (borchero) merged 3 commits into
mainfrom
fix-docs-check-list-items

Conversation

@kklein
Copy link
Copy Markdown
Contributor

@kklein Kevin Klein (kklein) commented May 15, 2026

Motivation

Before

Screenshot 2026-05-15 at 18 50 23

After

Screenshot 2026-05-15 at 18 55 37

Changes

  • Added whitespace

Copilot AI review requested due to automatic review settings May 15, 2026 17:04
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 15, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds blank lines between bullet items in docstrings so they render as a proper Markdown list in the generated docs, instead of being collapsed into a single paragraph.

Changes:

  • Inserted blank lines before each - bullet and before the trailing paragraph in the check argument docstring across all column type modules.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
dataframely/columns/_base.py Add blank lines between bullets in check docstring.
dataframely/columns/any.py Same docstring formatting fix.
dataframely/columns/array.py Same docstring formatting fix.
dataframely/columns/categorical.py Same docstring formatting fix.
dataframely/columns/datetime.py Same fix applied to all 4 __init__ docstrings.
dataframely/columns/decimal.py Same docstring formatting fix.
dataframely/columns/enum.py Same docstring formatting fix.
dataframely/columns/float.py Same docstring formatting fix.
dataframely/columns/integer.py Same docstring formatting fix.
dataframely/columns/list.py Same docstring formatting fix.
dataframely/columns/object.py Same docstring formatting fix.
dataframely/columns/string.py Same docstring formatting fix.
dataframely/columns/struct.py Same docstring formatting fix.

@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (e6ebab1) to head (dfe9c9c).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #340   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           56        56           
  Lines         3404      3404           
=========================================
  Hits          3404      3404           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you!

@borchero Oliver Borchert (borchero) merged commit cdb1ac9 into main May 15, 2026
32 checks passed
@borchero Oliver Borchert (borchero) deleted the fix-docs-check-list-items branch May 15, 2026 17:46
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants