search

ethpm / ethpm-spec

Ethereum Package Manager http://ethpm.github.io/ethpm-spec/
165 stars 30 forks source link

Migrate package spec description to Sphinx #93

Closed gnidan closed 6 years ago

gnidan commented 6 years ago

ℹ️ View this PR on the world wide web

njgheorghita commented 6 years ago

@gnidan nice! I like "package manifest specification" => "package manifest". Should we just get rid of "specification" altogether? like throughout docs/source/package-spec.rst

gnidan commented 6 years ago

Should we just get rid of "specification" altogether?

@njgheorghita I don't think it's redundant - the Package Manifest Specification specifies the format for package manifests. If anything, I'd suggest removing the word "manifest", since we refer to "package manifest" as just "package" in a bunch of places. I didn't do that here because this part of the documentation is low-level, so it seems prudent to be explicit.

njgheorghita commented 6 years ago

@gnidan Ok I see your point, I'm not married to using "manifest", I think the only reason it stuck around was because "manifest_version" is used in spec/package.spec.json. So i'd be open to changing that to spec_version or something else? ( i think package_version might get a little confusing as individual packages will have their own versions) and deprecating "package manifest" for just "package" everywhere

gnidan commented 6 years ago

Thanks for the approve! Let's discuss terminology in the channel or somewhere.