ethpm / ethpm-spec

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

Use e.g. (for example) instead of i.e. (in essence) #133

Closed davidmurdoch closed 5 years ago

davidmurdoch commented 5 years ago

"e.g." should be used when providing an example, whereas "i.e." should be use when providing clarification.

gnidan commented 5 years ago

Huh, I think we meant to say "id est" because those are the names of the use cases?

pipermerriam commented 5 years ago

Things I've never taken the time to fully internalize.

Here's a squirrel eating a pumpkin

squirrel in pumpkin photograph 2014 thanksgiving photo - 2014 thanksgiving squirrel in pumpkin autum-f41515

davidmurdoch commented 5 years ago

@gnidan, when I first read it I thought of the use case names (owned, transferable, etc.) as examples of the use case description titles.

So the "owned" contract was an example of a "Stand Alone Package with an Inheritable Contract".

I can see now what your intent was.

I have no issue if you want to close this PR. Perhaps the first section could just be a simple Table of Contents as a list, with each full description section linking to the folder of its example implementation. Let me know if this is something you'd prefer and I can open a PR real quick (or not) .

Words are hard.

@pipermerriam Are we sure that the pumpkin isn't eating the squirrel though? 🎃

njgheorghita commented 5 years ago

I'm getting horrible flashbacks to middle school english class - but according to this

E.g. is used to give one or more possible examples. It’s a signal that you’re seeing one or a few of multiple possibilities.

I.e, on the other hand, clarifies; you are providing more precise information. Where e.g. opens up more options, i.e. narrows them down.

It seems to me that e.g. is more appropriate. That being said, I really don't think it makes a big difference either way - we are programmers after all not literature experts - so I'm gonna move ahead and merge this - pls ping me if you think this was the wrong move :heart: