add a name: and mark it as required

add a name: and mark it as required


BUG=

[sethladd, 2012-08-29 08:53:48]

Wanted to make it clear that name: is required. PTAL. Thanks!

[Bob Nystrom, 2012-08-29 17:47:32]

Nits, but LGTM!

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/pubspec.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:32: **Required**: every
package needs a name. When your stellar code gets props on the world
This seems a bit ugly to me. Is it really necessary?

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:48: Every package has a
version. A version number is required to host your package on
Long line.

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/versioning.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/versioning.markdown:326: name: myapp
my_app to be consistent with above?

[sethladd, 2012-08-29 19:49:18]

Thanks. Made some tweaks.

Awesome fact: mere hours after I made this CL, we received this pull request:
https://github.com/dart-lang/dartlang.org/pull/3

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/pubspec.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:32: **Required**: every
package needs a name. When your stellar code gets props on the world
I care less about how we format this, but when I look at this as technical
documentation, we need to specify what is required and what is optional (in a
clear and concise way)

I'm open to how to say "required" in clear way. Ideas? Maybe a table of fields,
marked with required and optional?

This is great commentary, but also useful is the technical conciseness.

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:48: Every package has a
version. A version number is required to host your package on
On 2012/08/29 17:47:32, Bob Nystrom wrote:
> Long line.

Done.

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/versioning.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/versioning.markdown:326: name: myapp
On 2012/08/29 17:47:32, Bob Nystrom wrote:
> my_app to be consistent with above?

Done.

[Bob Nystrom, 2012-08-29 19:53:50]

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/pubspec.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:32: **Required**: every
package needs a name. When your stellar code gets props on the world
On 2012/08/29 19:49:18, sethladd wrote:
> I care less about how we format this, but when I look at this as technical
> documentation, we need to specify what is required and what is optional (in a
> clear and concise way)
> 
> I'm open to how to say "required" in clear way. Ideas? Maybe a table of
fields,
> marked with required and optional?
> 
> This is great commentary, but also useful is the technical conciseness.

Right now, there are only three fields, and one of them is required so I don't
know if we're quite ready for a table yet. But we will be adding more metadata
relatively soon. How about we iterate on this then?

[sethladd, 2012-08-29 20:01:41]

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
File src/site/docs/pub-package-manager/pubspec.markdown (right):

https://chromiumcodereview.appspot.com/10891023/diff/1/src/site/docs/pub-pack...
src/site/docs/pub-package-manager/pubspec.markdown:32: **Required**: every
package needs a name. When your stellar code gets props on the world
I changed it a bit in the latest patch. I think a table would be fine now,
actually, but it's not a big deal.

I can image:

field, required, type (num, strong, bool), format, notes

Also, this is the kind of thing we can do for you after things settle down a
little.