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
Request sample code for popular API docs #21136
Comments
Where in the repo are these docs? I took a quick look around and couldn't find them. |
@MisterJimson They are mixed with the code (comments that start with flutter/packages/flutter/lib/src/material/scaffold.dart Lines 657 to 691 in 5177a37
flutter/packages/flutter/lib/src/material/scaffold.dart Lines 714 to 729 in 5177a37
|
They don't seem to match with the web pages in this issue. For example, the Scaffold API doc webpage has these sentences not present in the code.
And these sentences from the repo's code Scaffold file are not present on the web page.
This issue is about updating the API docs webpages, from what I can see there does not seem to be a direct relationship between the docs in the code and on the website, unless I am missing something. |
|
@MisterJimson Sorry about the confusion. The reason you saw the discrepancy between the docs and the code is that docs.flutter.io is generated from the beta branch of Flutter, but the code you were looking at is on the master branch. The API docs for the master branch lives at https://master-docs-flutter-io.firebaseapp.com/ |
@InMatrix I just added some sample code for BottomNavigationBar and Scaffold. Would more later. |
* Added sample code for a simple Icon, ref: #21136 * Removed duplicate line. * Fixed incoreect parameter. * Update icon.dart Removed empty prose and added better context for sample code. Changed sample code for better visibility in execution of default app themes. * Alas, Trailing space. Nixed trailing space in comments.
Updated/Checked-off the completed sample code snippets. ref: master docs |
* Added code snippet for TextField class. ref:#21136 * Errant semicolon
* Update flat_button.dart * Added smaple code for Flat Button * Update flat_button.dart * Revert "Update flat_button.dart" This reverts commit c8f00df. * Revert "Added smaple code for Flat Button" This reverts commit adc4234. * Update flat_button.dart * Update flat_button.dart * Update flat_button.dart * remove white spaces * remove white spaces * add two different samples * Update flat_button.dart
* Added code snippet for Expanded class. ref:#21136 * Changed the code samples into snippet application samples.
* Added code snippets for FloatingActionButton Class. ref:#21136 * Extraneous white spaces. Co-Authored-By: Piinks <katelovett@google.com> * Alignment correction. * The analyze result wasn't showing on github interface. Checked through Cirrus and it's all-green. Co-Authored-By: Piinks <katelovett@google.com>
* Added code snippet for Form Class. ref:#21136 * Formatting adjustments. * Changed wording related to GlobalKey.
Hi @InMatrix cc @Piinks Is it safe to close this issue? |
Awesome! LGTM, and thank you for checking! I think we can close this now. 🎉 |
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of |
According to analytics, the following API docs are quite popular but they don't currently have any sample code. These are easy tasks to start contributing to the Flutter repo. Please refer to Flutter's style guide if you're interested in contributing a snippet.
The text was updated successfully, but these errors were encountered: