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.

Sign up for GitHub

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

Jump to bottom

[2.19] Remove ignore: undefined_method for all 2.19 code excerpts #4394

Closed
MaryaBelanger opened this issue Nov 21, 2022 · 3 comments · Fixed by #4460
Closed

[2.19] Remove ignore: undefined_method for all 2.19 code excerpts #4394

MaryaBelanger opened this issue Nov 21, 2022 · 3 comments · Fixed by #4460
Assignees
@MaryaBelanger
Labels
e0-minutes Can complete in < 60 minutes of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content from.team Reported by Dash docs team member p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.

Comments

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Nov 21, 2022 •
edited
Loading

I've been adding undefined_method to the // ignore_for_file: lines of all the code excerpts I've been writing in preparation of 2.19.

I'm assuming the best thing to do would be to remove these once 2.19 is stable so anyone editing them in the future can't accidentally add an actually undefined method to any of the code excerpts or tests.
@MaryaBelanger MaryaBelanger self-assigned this Nov 21, 2022
@parlough parlough added p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. e0-minutes Can complete in < 60 minutes of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content labels Nov 22, 2022
@parlough
Copy link
Member

parlough commented Nov 22, 2022 •
edited
Loading

I think if you're documenting future releases, unless the change needs to get in before 2.19 lands, it may be fine to just not ignore the error and let the build fail, as it could cause us to miss issues now or in the future.

If you want to get the change in before 2.19, I think it should be fine to comment out the code excerpt for now and make a TODO to add that back.

Especially if you have tests or other code relating to the change, the build will likely still fail anyway due to missing returned values.

@MaryaBelanger
Copy link
Contributor Author

Ok thanks for explaining, that seems like a much better way to handle it. I'll leave this open while I go back and remove the ignores sooner rather than later

@MaryaBelanger MaryaBelanger linked a pull request Dec 22, 2022 that will close this issue
Update SDK constraint for 2.19 examples and remove related ignores #4460
Merged
@parlough parlough mentioned this issue Dec 22, 2022
Merged
parlough added a commit that referenced this issue Dec 22, 2022
@parlough
Update SDK constraint for 2.19 examples and remove related ignores (#…
8f19247 
…4460)

- Updates lower SDK constraint for examples which use 2.19 features
- Removes ignores related to those elements missing
- Remove the `undefined_annotation` ignore in `docs_good.dart` by adding
a stub of the used annotation to the file
- Removes a duplicate "syntax"

Fixes #4394
@MaryaBelanger
Copy link
Contributor Author

Fixing PRs merged into v2.19

parlough added a commit that referenced this issue Jan 23, 2023
@parlough
Update SDK constraint for 2.19 examples and remove related ignores (#…
00408c4 
…4460)

- Updates lower SDK constraint for examples which use 2.19 features
- Removes ignores related to those elements missing
- Remove the `undefined_annotation` ignore in `docs_good.dart` by adding
a stub of the used annotation to the file
- Removes a duplicate "syntax"

Fixes #4394
parlough added a commit that referenced this issue Jan 23, 2023
@parlough
Update SDK constraint for 2.19 examples and remove related ignores (#…
9adfa86 
…4460)

- Updates lower SDK constraint for examples which use 2.19 features
- Removes ignores related to those elements missing
- Remove the `undefined_annotation` ignore in `docs_good.dart` by adding
a stub of the used annotation to the file
- Removes a duplicate "syntax"

Fixes #4394
parlough added a commit that referenced this issue Jan 24, 2023
@parlough
Update SDK constraint for 2.19 examples and remove related ignores (#…
f89f81c 
…4460)

- Updates lower SDK constraint for examples which use 2.19 features
- Removes ignores related to those elements missing
- Remove the `undefined_annotation` ignore in `docs_good.dart` by adding
a stub of the used annotation to the file
- Removes a duplicate "syntax"

Fixes #4394
parlough added a commit that referenced this issue Jan 24, 2023
@parlough
Update SDK constraint for 2.19 examples and remove related ignores (#…
69cedc4 
…4460)

- Updates lower SDK constraint for examples which use 2.19 features
- Removes ignores related to those elements missing
- Remove the `undefined_annotation` ignore in `docs_good.dart` by adding
a stub of the used annotation to the file
- Removes a duplicate "syntax"

Fixes #4394
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MaryaBelanger MaryaBelanger

Labels
e0-minutes Can complete in < 60 minutes of normal, not dedicated, work fix.refactor Needs near total rewrite or reorganization of content from.team Reported by Dash docs team member p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update SDK constraint for 2.19 examples and remove related ignores dart-lang/site-www
3 participants
@atsansone @parlough @MaryaBelanger