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.

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

docs(cordyceps): fix wrong time complexity notes #430

Merged
merged 3 commits into from
May 5, 2023
Merged

Conversation

hawkw
Copy link
Owner

@hawkw hawkw commented May 5, 2023

Currently, the cordyceps::List documentation states the time complexity of certain methods, such as pop_front, pop_back, push_front, and push_back, are O(n), while they are actually O(1). This commit fixes the incorrect docs.

Fixes #429

@hawkw hawkw enabled auto-merge (squash) May 5, 2023 17:00
@hawkw hawkw disabled auto-merge May 5, 2023 17:03
hawkw added 2 commits May 5, 2023 10:03
Currently, the `cordyceps::List` documentation states the time
complexity of certain methods, such as `pop_front`, `pop_back`,
`push_front`, and `push_back`, are *O*(*n*), while they are actually
*O*(1). This commit fixes the incorrect docs.

Fixes #429
This adds "# Returns" sections to the method documentation for some
`cordyceps::List` methods, as applicable.
@hawkw hawkw enabled auto-merge (rebase) May 5, 2023 17:13
@hawkw hawkw merged commit 3548032 into main May 5, 2023
18 checks passed
@hawkw hawkw deleted the eliza/constant-time branch May 5, 2023 17:39
hawkw added a commit that referenced this pull request May 5, 2023
Currently, the `cordyceps::List` documentation states the time
complexity of certain methods, such as `pop_front`, `pop_back`,
`push_front`, and `push_back`, are *O*(*n*), while they are actually
*O*(1). This commit fixes the incorrect docs.

Fixes #429
hawkw added a commit that referenced this pull request May 12, 2023
Currently, the `cordyceps::List` documentation states the time
complexity of certain methods, such as `pop_front`, `pop_back`,
`push_front`, and `push_back`, are *O*(*n*), while they are actually
*O*(1). This commit fixes the incorrect docs.

Fixes #429
hawkw added a commit that referenced this pull request May 12, 2023
This adds "# Returns" sections to the method documentation for some
`cordyceps::List` methods, as applicable.
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.

cordyceps::List docs for push_*/pop_* should claim constant time
1 participant