Recommend filenames for package examples #911
Conversation
googlebot
added
the
cla: yes
There was a problem hiding this comment.
I'd be great to put a comment somewhere there saying that the list is driven by the items here:
https:/dart-lang/pana/blob/ce8c0c812f0df8810bc71191e41f07b1c5c621bd/lib/src/maintenance.dart#L34-L44
src/tools/pub/package-layout.md
Outdated
| * <code>example/lib/<em>package_name</em>.dart</code> | ||
| * <code>example/<em>package_name</em>.dart</code> | ||
| * <code>example/<em>package_name</em>_example.dart</code> | ||
| * <code>example/example.dart</code> |
There was a problem hiding this comment.
Oops, and another one.
|
I'm a little leery of linking to the implementation, but I guess it's better than letting the docs possibly rot. However, just linking to where the files are listed isn't enough — you really need to look at where it's used. I put in the search I used, but maybe we could do something better? |
|
@kevmoo PTAL |
FYI, the new code_excerpter can extract the |
|
I'm going to commit this. We can update the code/link later. |
| For example, the json_serializable package contains a file named | ||
| `example/example.dart`, which appears in the | ||
| [json_serializable Example tab.](https://pub.dartlang.org/packages/json_serializable#pub-pkg-tab-example) | ||
| To see exactly how the example file is chosen, look at the |
There was a problem hiding this comment.
Sorry for the late response. I just meant add a code comment here so any future maintainer of this page knows where the data comes from!
Then it isn't weird to point to a specific file at a specific commit, etc.
|
Ah, OK, much better. :) I'll make that fix. |
Staged: https://kw-www-dartlang-1.firebaseapp.com/tools/pub/package-layout#examples
Fixes #413