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

📝 update the suspend() docs to account for v4 API #957

Merged
merged 3 commits into from
Jan 6, 2025
Merged

Conversation

cowboyd
Copy link
Member

@cowboyd cowboyd commented Jan 5, 2025

Motivation

The suspend operation is no longer fundamental. It is just an action that does nothing, so we had to update the docs to reflect that.

Approach

We had to change not only the API docs, but I also noticed that there were several places where the old action+suspend trick was being used that are no longer valid.

The suspend operation is no longer fundamental. It is just an action
that does nothing, so we had to update the docs to reflect that.

We had to change not only the API docs, but I also noticed that there
wer several places where the old `action+suspend` trick was being
used that are no longer valid.
@cowboyd cowboyd requested review from taras, neurosnap and jbolda January 5, 2025 17:51
www/docs/actions.mdx Outdated Show resolved Hide resolved
www/docs/actions.mdx Outdated Show resolved Hide resolved
www/docs/operations.mdx Outdated Show resolved Hide resolved
www/docs/operations.mdx Outdated Show resolved Hide resolved
Co-authored-by: David Brochart <david.brochart@gmail.com>
The suspend operation is no longer fundamental. It is just an action
that does nothing, so we had to update the docs to reflect that.

We had to change not only the API docs, but I also noticed that there
wer several places where the old `action+suspend` trick was being
used that are no longer valid.
@cowboyd
Copy link
Member Author

cowboyd commented Jan 6, 2025

Thanks as alway @davidbrochart! I really appreciate the time you have taken to proofread changes to our docs in this PR and so many others.

@cowboyd cowboyd merged commit e8232b6 into v4 Jan 6, 2025
3 checks passed
@cowboyd cowboyd deleted the v4-docs-suspend branch January 6, 2025 13:30
@davidbrochart
Copy link
Contributor

Thank you for merging, I hope I will contribute in a more significant way in the future :)

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