Skip to content

Ctable docs amends#630

Merged
FrancescAlted merged 7 commits intomainfrom
ctable-docs-amends
May 5, 2026
Merged

Ctable docs amends#630
FrancescAlted merged 7 commits intomainfrom
ctable-docs-amends

Conversation

@Jacc4224
Copy link
Copy Markdown
Collaborator

@Jacc4224 Jacc4224 commented May 5, 2026

html fixed, every function with description.

Jacc4224 added 4 commits May 5, 2026 12:11
- Add iter_sorted to Querying section (was missing entirely)
- Add to_parquet to Persistence section (from_parquet was there, to_parquet was not)
- Add vlstring / vlbytes to Schema Specs -> Text & binary section
- Add autoattribute entries for col_names and base (were listed in the
  attributes autosummary but had no corresponding autodoc directive)
- Add class-level annotations (#:) for col_names and base in CTable so
  Sphinx autoattribute can render them with descriptions
- Add docstring to Column.dtype property (was bare one-liner with no doc)
Copy link
Copy Markdown
Member

@FrancescAlted FrancescAlted left a comment

Choose a reason for hiding this comment

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

I have some suggestions

Comment thread doc/reference/ctable.rst Outdated
Comment thread doc/reference/ctable.rst Outdated
Comment thread doc/reference/ctable.rst Outdated
Comment thread doc/reference/ctable.rst Outdated
Copy link
Copy Markdown
Member

@FrancescAlted FrancescAlted left a comment

Choose a reason for hiding this comment

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

Still a couple of suggestions. we are closer now.

Comment thread doc/reference/ctable.rst Outdated
Comment thread doc/reference/ctable.rst Outdated
@FrancescAlted FrancescAlted self-requested a review May 5, 2026 15:39
Copy link
Copy Markdown
Member

@FrancescAlted FrancescAlted left a comment

Choose a reason for hiding this comment

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

LGTM

@FrancescAlted FrancescAlted merged commit f494c63 into main May 5, 2026
16 checks passed
@FrancescAlted FrancescAlted deleted the ctable-docs-amends branch May 5, 2026 15:40
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