Clarify author documentation and template #1738

Merged
merged 2 commits into from Jan 9, 2014

Projects

None yet

5 participants

@floere
CocoaPods member

I noticed pod spec writers sometimes leaving in "other author" for the author in their specs, and since this slightly dirty data makes the cocoapods.org search engine find pods which should not be found, I am trying to make a start such that people provide cleaner data.

This removes the "other author" in the example.

@mtitolo
CocoaPods member

"CocoaPods also accepts just a name if you'd rather not provide an email addresses." ? Seems a bit more polite.

@floere
CocoaPods member

Absolutely true!

@floere
CocoaPods member

People also use AUTHORS files. Perhaps this would be a good addition, akin to s.license = { :type => 'MIT', :file => 'FILE_LICENSE' }. So… s.authors = { :file => 'AUTHORS' }. But perhaps that's just overkill.

@mtitolo
CocoaPods member

Yes, but that'd be a change to the DSL, correct?

@floere
CocoaPods member

Yes, absolutely. That would necessitate adding code on our side and assumes a definition of the AUTHORS file. (Ok, I retract my idea ;) )

@mtitolo mtitolo merged commit cb539e2 into master Jan 9, 2014

1 check passed

Details default The Travis CI build passed
@mtitolo mtitolo deleted the author-doc branch Jan 9, 2014
@fabiopelosin
CocoaPods member

👍

@rivera-ernesto

"Addresses" should be singular now ;)

Oops, e42d5f6 should resolve that @rivera-ernesto.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment