100% doc coverage in package:flutter_driver #6738
Conversation
There was a problem hiding this comment.
Are there conventions for how to format this string? e.g. capitalisation, punctuation
There was a problem hiding this comment.
Human-readable, or machine-readable, or debugging aid only?
There was a problem hiding this comment.
Probably gives some pointers here.
Also even package-private classes should have some docs so other package authors can figure it out. :-)
There was a problem hiding this comment.
Needs more detail. Any time you feel tempted to write docs that could have been written by someone who knew nothing other than the fully-qualified name of the identifier, you need more detail. :-)
There was a problem hiding this comment.
This should document the shape of the returned JSON object
There was a problem hiding this comment.
grammar is dubious in this sentence
There was a problem hiding this comment.
Anywhere where you currently say "Deserializes this command from JSON.", you should either describe the expected shape of the JSON input, or point to the API that generates the expected JSON in the first place.
There was a problem hiding this comment.
Done (pointed to the corresponding serialize methods).
There was a problem hiding this comment.
Should probably elaborate on what "submit" means.
There was a problem hiding this comment.
There was a problem hiding this comment.
here and below, you should talk about the JSON shape or point to the encoder
There was a problem hiding this comment.
The link to the format is on the class` dartdoc, but I moved it here.
There was a problem hiding this comment.
this should probably point to [Timeline].
|
This is great! |
|
|
yjbanov
force-pushed
the
driver-docs
branch
2 times, most recently
from
6c908ab to
174c7a0
Compare
flutter/engine@3374f4c...fb5b097 git log 3374f4c..fb5b097 --no-merges --oneline fb5b097 Revert "Roll freetype2 to a10b062df0c8958d69377aa04ea6554a9961a111 (flutter#6738)" (flutter/engine#6763) 4fd2d14 Roll src/third_party/skia 5b2bda70e52f..11407e56f277 (1 commits) (flutter/engine#6762) fa4c01e Add an Info.plist flag to enable the embedded iOS views preview. (flutter/engine#6756) ded297f Roll src/third_party/skia df8225e253a2..5b2bda70e52f (5 commits) (flutter/engine#6761) f0380b3 Roll src/third_party/skia 32262da42bed..df8225e253a2 (10 commits) (flutter/engine#6755) 124f20f Clear the on-screen surface every frame. (flutter/engine#6753) The AutoRoll server is located here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+/master/autoroll/README.md If the roll is causing failures, please contact the current sheriff, who should be CC'd on the roll, and stop the roller if necessary.
flutter/engine@3374f4c...fb5b097 git log 3374f4c..fb5b097 --no-merges --oneline fb5b097 Revert "Roll freetype2 to a10b062df0c8958d69377aa04ea6554a9961a111 (#6738)" (flutter/engine#6763) 4fd2d14 Roll src/third_party/skia 5b2bda70e52f..11407e56f277 (1 commits) (flutter/engine#6762) fa4c01e Add an Info.plist flag to enable the embedded iOS views preview. (flutter/engine#6756) ded297f Roll src/third_party/skia df8225e253a2..5b2bda70e52f (5 commits) (flutter/engine#6761) f0380b3 Roll src/third_party/skia 32262da42bed..df8225e253a2 (10 commits) (flutter/engine#6755) 124f20f Clear the on-screen surface every frame. (flutter/engine#6753) The AutoRoll server is located here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+/master/autoroll/README.md If the roll is causing failures, please contact the current sheriff, who should be CC'd on the roll, and stop the roller if necessary.
2 participants
I added docs in most places. A few members were converted to private.
Fixes #5883
/cc @Hixie