Skip to content

improved digital compatibility docs #136

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

Merged
merged 2 commits into from
Jun 13, 2019
Merged

improved digital compatibility docs #136

merged 2 commits into from
Jun 13, 2019

Conversation

ryankurte
Copy link
Contributor

No description provided.

Copy link
Contributor

@dbrgn dbrgn left a comment

Choose a reason for hiding this comment

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

Docs improvements are always great 🙂 Thanks!

//! pub fn new(pin: T) -> OldOutputPinConsumer<T> {
//! OldOutputPinConsumer{ _pin: pin }
//! }
//! }
Copy link
Contributor

Choose a reason for hiding this comment

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

The docs could be a bit shorter if you'd skip the new function and simply make the _pin field pub pin instead, and then directly assign the value in main.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i think i prefer the new method as it shows how you'd usually use it (with the where clause), am okay to change it if you disagree strongly.

//! pub fn new(pin: T) -> NewOutputPinConsumer<T> {
//! NewOutputPinConsumer{ _pin: pin }
//! }
//! }
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thing here with the new function.

Copy link
Contributor

@therealprof therealprof left a comment

Choose a reason for hiding this comment

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

LGTM

@therealprof
Copy link
Contributor

bors r+

bors bot added a commit that referenced this pull request Jun 6, 2019
136: improved digital compatibility docs r=therealprof a=ryankurte



Co-authored-by: Ryan Kurte <ryankurte@gmail.com>
@bors
Copy link
Contributor

bors bot commented Jun 6, 2019

Build failed

@dbrgn
Copy link
Contributor

dbrgn commented Jun 11, 2019

Again, bors build fails because we deny warnings.

I'll create a PR to remove that line.

@ryankurte
Copy link
Contributor Author

bors retry

bors bot added a commit that referenced this pull request Jun 13, 2019
136: improved digital compatibility docs r=therealprof a=ryankurte



Co-authored-by: Ryan Kurte <ryankurte@gmail.com>
@bors
Copy link
Contributor

bors bot commented Jun 13, 2019

Build succeeded

@bors bors bot merged commit 79ae58c into master Jun 13, 2019
@bors bors bot deleted the docs/digital-compat branch June 13, 2019 02:39
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.

3 participants