Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Add documentation_url attribute to Specification DSL. #1273

Closed
fabiopelosin opened this Issue · 15 comments

4 participants

@fabiopelosin
Owner

No description provided.

@fabiopelosin
Owner

The proposed solution would be to introduce the documentation_url attribute (to avoid confusion with the deprecated documentation). If a Pod specifies a value for it the CocoaPods web properties will use that url as the documentation link. Moreover if this value has been specified the CocoaDocs will display a prominent notice indicating the canonical URL for the documentation.

@incanus incanus referenced this issue in mapbox/mapbox-ios-sdk
Closed

fix CocoaPods docs #277

@incanus

How is this used? It's not documented and it's not working on http://cocoapods.org/?q=mapbox (first result, the SDK) as changed in 280be09.

@keith
Collaborator

Not 100% sure but the changelog makes it look like it's still just part of the master branch, not yet into the tool. https://github.com/CocoaPods/CocoaPods/blob/a15b69f7471e31db15228e897c71b7730d187215/CHANGELOG.md#master

@incanus
@keith
Collaborator

I reverted it since it isn't linting alright at all right now on Travis CocoaPods/Specs@d6c4e24

@keith keith referenced this issue from a commit in CocoaPods/Specs
@incanus incanus switching to self-hosted docs for MapBox 280be09
@orta
Owner

weird

@fabiopelosin

I think that we just need to update the bundle of the specs repo.

@keith
Collaborator

Interesting, is the only purpose for it having a Gemfile at all because of Travis builds? If so we could probably delete the lock file so it would install the newest version on each run?

@fabiopelosin

I prefer to have some control on it. There have been a couple of situations where having the gem locked to a specific versions was handy. I.e. cleaning up the repo before introducing a stricter check or avoid using a bugged release versions. Also having the gemfile is useful for linting locally otherwise you could be using an outdated version of CocoaPods.

I think that the best approach is to update the bundle while we update the last know version (part of the release task), for the time being (i.e. before 1.0) this could be the best approach.

@keith
Collaborator

Sounds good, should I update this now until the next release?

@fabiopelosin

@Keithbsmiley :+1: I updated it locally but didn't push because there are a couple of Pods which need whitelisting (example homepage) and I won't have time.

@keith
Collaborator

Hmm, I'm having trouble with building native extensions, so if someone else has a chance to make that happen

@fabiopelosin fabiopelosin referenced this issue from a commit in CocoaPods/Specs
@fabiopelosin fabiopelosin Bump CocoaPods version ae50cb3
@incanus incanus referenced this issue from a commit in CocoaPods/Specs
@incanus incanus refs CocoaPods/CocoaPods#1273: update Mapbox docs URLs a4b6600
@incanus

I've updated my podspec per above but cocoapods.org is still linking to http://cocoadocs.org/docsets/MapBox/1.0.3/ as before. Any ideas?

@orta
Owner
@incanus incanus referenced this issue in CocoaPods/cocoapods.org
Closed

docs not pointing properly #23

@umjames umjames referenced this issue from a commit in umjames/Specs
@fabiopelosin fabiopelosin Bump CocoaPods version 8f56571
@Abizern Abizern referenced this issue from a commit
Commit has since been removed from the repository and is no longer available.
@Abizern Abizern referenced this issue from a commit
Commit has since been removed from the repository and is no longer available.
@incanus incanus referenced this issue from a commit in CocoaPods/Specs
@incanus incanus refs CocoaPods/CocoaPods#1273: update Mapbox docs URLs 6710786
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.