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

Updated documentation for issue 572 #573

Merged
merged 2 commits into from
Mar 3, 2020
Merged

Updated documentation for issue 572 #573

merged 2 commits into from
Mar 3, 2020

Conversation

jaapbrasser
Copy link
Contributor

@jaapbrasser jaapbrasser commented Mar 3, 2020

Description

Example documentation should be provided in the following format:

Code to Run
Description what the code above does
This is the case for all functions in the module, Get-RubrikLogshipping is the exception and should follow this convention as well.

Related Issue

This project only accepts pull requests related to open issues.

Resolve #572

Motivation and Context

Create consistent documentation

How Has This Been Tested?

Documentation update, no testing required

Screenshots (if appropriate):

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTION document.
  • I have updated the CHANGELOG file accordingly for the version that this merge modifies.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@jaapbrasser jaapbrasser requested review from a team, mwpreston and shamsway and removed request for a team March 3, 2020 05:43
@mwpreston mwpreston merged commit b1d2177 into devel Mar 3, 2020
@mwpreston mwpreston deleted the jaap-572 branch March 3, 2020 17:54
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.

Example documentation in Get-RubrikLogShipping is in the wrong order
2 participants