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: fix parameter in usage.md #332

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

capsenz
Copy link
Contributor

@capsenz capsenz commented Nov 13, 2024

Fixed parameter in of DocumentStream in usage.md.

Issue resolved by this Pull Request:
Resolves #331

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the
    conventional commits.
  • Documentation has been updated, if necessary.
  • Examples have been added, if necessary.
  • Tests have been added, if necessary.

Copy link
Contributor

@cau-git cau-git left a comment

Choose a reason for hiding this comment

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

LGTM

@dolfim-ibm
Copy link
Contributor

@capsenz thanks for your first contribution. Before we can approve and merge this, we require you to rebase your commit with a sign-off. See the the CONTRIBUTING.md guidelines.

In practice, these steps should do it.

To add your Signed-off-by line to every commit in this branch:

  1. Ensure you have a local copy of your branch by checking out the pull request locally via command line.
  2. In your local branch, run: git rebase HEAD~1 --signoff
  3. Force push your changes to overwrite the branch: git push --force-with-lease origin docs/documentstream_in_usage

Copy link
Contributor

@dolfim-ibm dolfim-ibm left a comment

Choose a reason for hiding this comment

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

we need DCO to pass correctly

@capsenz capsenz force-pushed the docs/documentstream_in_usage branch from 3f96a78 to 4a584e8 Compare November 14, 2024 21:39
@capsenz
Copy link
Contributor Author

capsenz commented Nov 14, 2024

DCO passed so this should be good to go

@dolfim-ibm dolfim-ibm merged commit 835e077 into DS4SD:main Nov 15, 2024
6 checks passed
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.

Fix documentation for DocumentStream in usage.md
3 participants