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

added cover example #145

Merged
merged 2 commits into from
Nov 30, 2023
Merged

added cover example #145

merged 2 commits into from
Nov 30, 2023

Conversation

wtahler
Copy link
Contributor

@wtahler wtahler commented Nov 27, 2023

Description

added an example to the Cover section of the README to support the new cover class.
copied the switch example and modified it to show cover configuration and example usage
fixed typo in number of states listed for cover in README

License Acceptance

  • This repository is Apache version 2.0 licensed and by making this PR, I am contributing my changes to the repository under the terms of the Apache 2 license.

Type of changes

  • Add/update a helper script
  • Add/update link to an external resource like a blog post or video
  • Bug fix
  • New feature
  • Test updates
  • Text cleanups/updates

Checklist

  • I have read the CONTRIBUTING document.
  • [n/a] All new and existing tests pass.
  • [n/a] Any scripts added use #!/usr/bin/env interpreter instead of potentially platform-specific direct paths (#!/bin/sh is an allowed exception)
  • [n/a] Scripts added/updated in this PR are all marked executable.
  • [n/a] Scripts added/updated in this PR do not have a language file extension unless they are meant to be sourced and not run standalone. No one should have to know if a script was written in bash, python, ruby or whatever. Not including file extensions makes it easier to rewrite the script in another language later without having to change every reference to the previous version.
  • I have confirmed that any links added or updated in my PR are valid.

Copy link
Owner

@unixorn unixorn left a comment

Choose a reason for hiding this comment

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

Lgtm, thanks for the documentation update

@unixorn unixorn merged commit fbc47b0 into unixorn:main Nov 30, 2023
4 checks passed
@ha-enthus1ast
Copy link
Contributor

I somehow missed to add my example code to the readme. Thanks @wtahler. Lgtm!

@ha-enthus1ast
Copy link
Contributor

@unixorn perhaps you can close #127 now?

@unixorn
Copy link
Owner

unixorn commented Dec 1, 2023

Done, thanks

@unixorn unixorn added the documentation Improvements or additions to documentation label Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants