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

[shared_preferences] fix documentation wording #4986

Merged
merged 2 commits into from
Oct 10, 2023

Conversation

Leptopoda
Copy link
Contributor

The wording of the SharedPreferences.containsKey docs was off. This PR improves the documentation.

none. I can open an issue if really necessary.

n.a.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@Leptopoda
Copy link
Contributor Author

Ok I don't know why submit-queue is failing.
Any help/insight would be great.

Copy link
Contributor

@tarrinneal tarrinneal left a comment

Choose a reason for hiding this comment

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

nice catch! Thanks for putting this pr up!

@tarrinneal tarrinneal added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 25, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Sep 25, 2023

auto label is removed for flutter/packages/4986, due to This PR has not met approval requirements for merging. You are not a member of flutter-hackers and need 1 more review(s) in order to merge this PR.

  • Merge guidelines: You need at least one approved review if you are already part of flutter-hackers or two member reviews if you are not a flutter-hacker before re-applying the autosubmit label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 25, 2023
@tarrinneal
Copy link
Contributor

I always forget that one... @stuartmorgan for second approval?

@@ -1,3 +1,7 @@
## 2.2.2

* Updates documentation for `containsKey`
Copy link
Contributor

Choose a reason for hiding this comment

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

This is missing a period; please see the CHANGELOG style guide linked from the PR checklist.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry 😅

I also just queued the changes for NEXT as I don't think a version bump is needed. Correct me if I should change it back.

Copy link
Contributor

Choose a reason for hiding this comment

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

Which exemption reason linked from the PR checklist would this PR fall under?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok I somehow miss read

Non-code changes that we make to future-proof development in some way, but don't directly benefit clients. Examples of this include

And only saw the part with Non-code changes.
I'll revert it again.

@stuartmorgan
Copy link
Contributor

stuartmorgan commented Sep 25, 2023

Not for this PR, but someday we should fix all those comments; saying they are reading from/checking/etc. "persistent storage" is highly misleading given that there is at least one, and on most platforms two, layers of cache involved.

@Leptopoda Leptopoda force-pushed the fix/shared_prefs/docs branch 2 times, most recently from fea732d to ea466b8 Compare September 26, 2023 07:45
Signed-off-by: Nikolas Rimikis <leptopoda@users.noreply.github.com>
@stuartmorgan stuartmorgan added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 10, 2023
@auto-submit auto-submit bot merged commit f89e408 into flutter:main Oct 10, 2023
70 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 11, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 11, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 12, 2023
fluttermirroringbot pushed a commit to flutter/flutter that referenced this pull request Oct 12, 2023
flutter/packages@4b483f2...93c3f69

2023-10-12 goderbauer@google.com [shared_preferences] update file version constraints (flutter/packages#5121)
2023-10-12 supercionci@hotmail.it [cross_file] Improved documentation about ignored parameters in IO module. (flutter/packages#4416)
2023-10-11 41873024+droidbg@users.noreply.github.com [in_app_purchase] [#135759] Fix. doc reference finishPurchase to completePurchase. (flutter/packages#5081)
2023-10-10 zeucxb@gmail.com Update repo README issues link (flutter/packages#5106)
2023-10-10 43643339+nohli@users.noreply.github.com [flutter_markdown] Fix typo in readme (flutter/packages#5096)
2023-10-10 43054281+camsim99@users.noreply.github.com [camerax] Implements torch mode (flutter/packages#4903)
2023-10-10 25266387+Leptopoda@users.noreply.github.com [shared_preferences] fix documentation wording (flutter/packages#4986)
2023-10-10 katelovett@google.com [two_dimensional_scrollables] Fix paint bug when rows/columns are pinned and axes are reversed (flutter/packages#5038)
2023-10-10 engine-flutter-autoroll@skia.org Roll Flutter from f52fe4f to 83134ac (25 revisions) (flutter/packages#5104)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
HugoOlthof pushed a commit to moneybird/packages that referenced this pull request Dec 13, 2023
The wording of the `SharedPreferences.containsKey` docs was off. This PR improves the documentation.

none. I can open an issue if really necessary.

n.a.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autosubmit Merge PR when tree becomes green via auto submit App p: shared_preferences
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants