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

rbd: document SparsifyWithProgress callback's arguments #861

Merged
merged 2 commits into from
Apr 5, 2023

Conversation

phlogistonjohn
Copy link
Collaborator

As discussed in #851, we wanted to fully document the arguments the callback function is expected to be called with.

Checklist

  • Added tests for features and functional changes
  • Public functions and types are documented
  • Standard formatting is applied to Go code
  • Is this a new API? Added a new file that begins with //go:build ceph_preview
  • Ran make api-update to record new APIs

New or infrequent contributors may want to review the go-ceph Developer's Guide including the section on how we track API Status and the API Stability Plan.

The go-ceph project uses mergify. View the mergify command guide for information on how to interact with mergify. Add a comment with @Mergifyio rebase to rebase your PR when github indicates that the PR is out of date with the base branch.

As discussed in ceph#851, we wanted to fully document the arguments the
callback function is expected to be called with.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
@phlogistonjohn phlogistonjohn added the no-API This PR does not include any changes to the public API of a go-ceph package label Apr 4, 2023
We overlooked this in review, before this makes it into a release let's
remove the referential redundancy with rapidity.

Signed-off-by: John Mulligan <jmulligan@redhat.com>
Copy link
Collaborator

@anoopcs9 anoopcs9 left a comment

Choose a reason for hiding this comment

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

All good, thanks.

@anoopcs9 anoopcs9 requested a review from ansiwen April 4, 2023 18:19
@anoopcs9
Copy link
Collaborator

anoopcs9 commented Apr 4, 2023

Adding extended-review label to give @ansiwen a chance to look at the change. Please remove the label once you approve for automatic merge.

@anoopcs9 anoopcs9 added the extended-review A submitter or reviewer feels the PR needs an extended review period label Apr 4, 2023
@phlogistonjohn phlogistonjohn removed the extended-review A submitter or reviewer feels the PR needs an extended review period label Apr 5, 2023
@mergify mergify bot merged commit 743c43b into ceph:master Apr 5, 2023
12 checks passed
@phlogistonjohn phlogistonjohn deleted the jjm-doc-tweak branch April 10, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-API This PR does not include any changes to the public API of a go-ceph package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants