docs: Fix docs check list items#340
Merged
Merged
Conversation
There was a problem hiding this comment.
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 thecheckargument 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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Oliver Borchert (borchero)
approved these changes
May 15, 2026
Member
Oliver Borchert (borchero)
left a comment
There was a problem hiding this comment.
Thank you!
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
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.
Motivation
Before
After
Changes