Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Fix docs for SemanticsAction #52229

Merged
merged 3 commits into from
Apr 18, 2024
Merged

Conversation

goderbauer
Copy link
Member

@goderbauer goderbauer commented Apr 18, 2024

The old rendering:

image

This changes uses markdown syntax introduced in dart-archive/markdown@5fab3a7

Fixes flutter/flutter#94494.

@goderbauer goderbauer requested a review from chunhtai April 18, 2024 17:43
Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

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

LGTM

/// - file://./../../lib/ui/semantics/semantics_node.h
/// > [!Warning]
/// > When changes are made to this class, the equivalent APIs in
/// > `lib/ui/semantics/semantics_node.h` and in each of the embedders
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this have to be in public doc?

Copy link
Contributor

Choose a reason for hiding this comment

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

Seems like something we can use // instead

Copy link
Member Author

Choose a reason for hiding this comment

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

https://github.com/flutter/engine/pull/19817/files turned it from private to public with this non-existing \warning thingy. I would also prefer keeping this private, but also don't want to flip-flop between the two every four years or so. Should we once and for all (lol) take this out of the public docs?

Copy link
Contributor

Choose a reason for hiding this comment

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

let's take it out, I missed this part when I reviewed the pr.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@goderbauer goderbauer added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 18, 2024
@auto-submit auto-submit bot merged commit 010c9de into flutter:main Apr 18, 2024
29 checks passed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 18, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Apr 18, 2024
…147006)

flutter/engine@46ff024...13a6ce4

2024-04-18 [email protected] Roll Skia from dc6df9137614 to 1af1e478ef85 (10 revisions) (flutter/engine#52230)
2024-04-18 [email protected] Fix docs for SemanticsAction (flutter/engine#52229)
2024-04-18 [email protected] Roll Dart SDK from a0caf3de902d to 8d834bbb2163 (1 revision) (flutter/engine#52228)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] 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
gilnobrega pushed a commit to gilnobrega/flutter that referenced this pull request Apr 22, 2024
…lutter#147006)

flutter/engine@46ff024...13a6ce4

2024-04-18 [email protected] Roll Skia from dc6df9137614 to 1af1e478ef85 (10 revisions) (flutter/engine#52230)
2024-04-18 [email protected] Fix docs for SemanticsAction (flutter/engine#52229)
2024-04-18 [email protected] Roll Dart SDK from a0caf3de902d to 8d834bbb2163 (1 revision) (flutter/engine#52228)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] 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
@goderbauer goderbauer deleted the fixSemanticsActionDoc branch April 23, 2024 16:55
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
autosubmit Merge PR when tree becomes green via auto submit App
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for SemanticsAction needs minor cleanup
2 participants