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

Fix parameter default documentation typos #1374

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

james-garriss
Copy link
Collaborator

@james-garriss james-garriss commented Oct 23, 2024

πŸ—£ Description

Minor changes to the docs.

πŸ’­ Motivation and context

Closes: #1352

πŸ§ͺ Testing

Changed docs.
Viewed in Github.
Checked pipeline.

βœ… Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • These code changes follow the ScubaGear [content style guide]
  • Related issues these changes resolve are linked preferably via [closing keywords]- [ ] All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

βœ… Pre-merge checklist

  • PR passed smoke test check.
  • Feature branch has been rebased against changes from parent branch, as needed
  • Resolved all merge conflicts on branch
  • Notified merge coordinator that PR is ready for merge via comment mention

βœ… Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@james-garriss james-garriss added the documentation This issue or pull request improves or adds to documentation label Oct 23, 2024
@james-garriss james-garriss added this to the Kraken milestone Oct 23, 2024
@james-garriss james-garriss self-assigned this Oct 23, 2024
@james-garriss james-garriss changed the title Minor documentation updates Fix parameter default documentation typos Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue or pull request improves or adds to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Minor parameter documentation mistakes
1 participant