Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[COL-526] Update and consolidate docstring comments #256

Merged
merged 7 commits into from
Nov 23, 2023
Merged

[COL-526] Update and consolidate docstring comments #256

merged 7 commits into from
Nov 23, 2023

Conversation

m-hulbert
Copy link
Collaborator

This PR updates all docstring comments. Broadly speaking, it:

  • Consolidates the content taken from the docs site and class definitions.
  • Removes labels of where content was sourced from.
  • Makes comments consistent where appropriate.

@m-hulbert m-hulbert self-assigned this Nov 22, 2023
@github-actions github-actions bot temporarily deployed to staging/pull/256/typedoc November 22, 2023 09:41 Inactive
@m-hulbert m-hulbert requested a review from dpiatek November 22, 2023 09:42
dpiatek
dpiatek suggested changes Nov 22, 2023
View reviewed changes
src/Cursors.ts Outdated Show resolved Hide resolved
src/Locks.ts Show resolved Hide resolved
src/Locks.ts Show resolved Hide resolved
src/Members.ts Outdated Show resolved Hide resolved
src/types.ts Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to staging/pull/256/typedoc November 22, 2023 15:44 Inactive
@m-hulbert m-hulbert requested a review from dpiatek November 22, 2023 15:46
dpiatek
dpiatek approved these changes Nov 22, 2023
View reviewed changes
Copy link
Contributor

@dpiatek dpiatek left a comment

Choose a reason for hiding this comment

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

Just the rebase, awesome work 🔥

@m-hulbert m-hulbert force-pushed the col-526-docstring-updates branch from 5f81989 to 40ee2cc Compare November 22, 2023 17:43
@github-actions github-actions bot temporarily deployed to staging/pull/256/typedoc November 22, 2023 17:44 Inactive
@m-hulbert m-hulbert force-pushed the col-526-docstring-updates branch from 40ee2cc to 8b9ddcc Compare November 23, 2023 11:38
@m-hulbert m-hulbert merged commit c61d907 into main Nov 23, 2023
7 checks passed
@m-hulbert m-hulbert deleted the col-526-docstring-updates branch November 23, 2023 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dpiatek dpiatek dpiatek approved these changes

Assignees

@m-hulbert m-hulbert

Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@m-hulbert @dpiatek