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

Removes output from Examples that break the docs #8017

Merged
merged 6 commits into from Dec 8, 2021

Conversation

MikeyBronowski
Copy link
Contributor

Type of Change

  • Bug fix (non-breaking change, fixes # )
  • New feature (non-breaking change, adds functionality, fixes # )
  • Breaking change (effects multiple commands or functionality, fixes # )
  • Ran manual Pester test and has passed (.\tests\manual.pester.ps1)
  • Adding code coverage to existing functionality
  • Pester test is included
  • If new file reference added for test, has is been added to github.com/sqlcollaborative/appveyor-lab ?
  • Unit test is included
  • Documentation
  • Build system

Purpose

The docs are broken by this format, plus other examples do not include outputs.

image

Approach

Commands to test

Screenshots

Learning

Copy link
Contributor

@andreasjordan andreasjordan left a comment

Choose a reason for hiding this comment

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

I'm totally fine with removing the output.

@niphlod
Copy link
Contributor

niphlod commented Dec 6, 2021

all it takes is prefixing the output with > to not break the docs, IMHO having an example of what the command gives back is super-useful.

@potatoqualitee
Copy link
Member

Thank you, @niphlod . @MikeyBronowski would you be able to prefix the output with > instead? 🙏🏼

@MikeyBronowski
Copy link
Contributor Author

Thank you, @niphlod . @MikeyBronowski would you be able to prefix the output with > instead? 🙏🏼

Sure. Will do that.

@MikeyBronowski
Copy link
Contributor Author

@potatoqualitee @niphlod done

@potatoqualitee
Copy link
Member

awessome thank you all!

@potatoqualitee potatoqualitee merged commit a5ebcd2 into dataplat:development Dec 8, 2021
@MikeyBronowski MikeyBronowski deleted the helpformatting branch December 8, 2021 15:31
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.

None yet

5 participants