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

Update IgnoreChangeTest documentation #62

Merged
merged 1 commit into from
Jul 18, 2018

Conversation

xqwzts
Copy link
Contributor

@xqwzts xqwzts commented Jul 13, 2018

My understanding of the ignoreChange code contradicts the provided dartdoc:

The doc states:

/// To ignore a change, provide a function that returns true or false. If the
/// returned value is false, the change will be ignored.

But the code shows:

_stream = _stream.where((state) => !widget.ignoreChange(state));

Which means that changes are ignored if ignoreChange returns true [fitting with the naming].

This is a quick one-word PR that modifies the doc.

Fixes the `IgnoreChangeTest` DartDoc comment to state that changes are ignored if the returned value is `true` not `false` as previously claimed.
@codecov
Copy link

codecov bot commented Jul 18, 2018

Codecov Report

Merging #62 into master will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #62      +/-   ##
==========================================
+ Coverage   98.76%   98.83%   +0.07%     
==========================================
  Files           1        1              
  Lines          81       86       +5     
==========================================
+ Hits           80       85       +5     
  Misses          1        1
Impacted Files Coverage Δ
lib/flutter_redux.dart 98.83% <ø> (+0.07%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 13fdd9a...cad2724. Read the comment docs.

@brianegan
Copy link
Owner

Excellent, thanks! Sorry for the delay, was super busy the past few weeks and needed a bit of recovery time this week :)

I re-ran the tests (for some reason Travis timed out the first time) and everything is passing again. I'll publish an update with this change :)

@brianegan brianegan merged commit dfc42c3 into brianegan:master Jul 18, 2018
@xqwzts xqwzts deleted the ignore_change_doc branch July 19, 2018 10:42
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

2 participants