Skip to content

Complete doc string examples for functions.py#1435

Open
ntjohnson1 wants to merge 8 commits intoapache:mainfrom
rerun-io:nick/polish_docstrings
Open

Complete doc string examples for functions.py#1435
ntjohnson1 wants to merge 8 commits intoapache:mainfrom
rerun-io:nick/polish_docstrings

Conversation

@ntjohnson1
Copy link
Contributor

@ntjohnson1 ntjohnson1 commented Mar 18, 2026

Which issue does this PR close?

Closes #1434 and #1433

Rationale for this change

Added coverage over MOST functions in functions.py with examples but split things up to be reviewable. There were a couple global notes that got lost across the many PRs

This relies on #1418 landing first since I branched from there. (MERGED and rebased)
This PR isn't as large as the diff suggests because a lot of changes are simple formatting. Reviewing by commit should make it much easier.

  • Cover remaining functions
  • Format aliases with See Also blocks
  • Format Examples to match google doc string style (biggest churn)
  • Remove unnecessary use of builtins
  • Cover optional arguments (in multiple commits to chunk it up)

@ntjohnson1 ntjohnson1 force-pushed the nick/polish_docstrings branch from 021597f to 6a5991c Compare March 19, 2026 14:12
@ntjohnson1 ntjohnson1 marked this pull request as ready for review March 19, 2026 14:18
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.

Add full example coverage to functions

1 participant