Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

“View Source on GitHub” links in documentation are broken #7565

Closed
1ec5 opened this issue Jan 1, 2017 · 2 comments
Closed

“View Source on GitHub” links in documentation are broken #7565

1ec5 opened this issue Jan 1, 2017 · 2 comments
Assignees
Labels
bug documentation iOS Mapbox Maps SDK for iOS
Milestone

Comments

@1ec5
Copy link
Contributor

1ec5 commented Jan 1, 2017

#7337 changed the framework-root configuration variable for jazzy from ../darwin/src to the hard-coded path build/ios/pkg/dynamic/Mapbox.framework. Now the “View Source on GitHub” links point to e.g. https://github.com/mapbox/mapbox-gl-native/tree/ios-v3.4.0-beta.6/build/ios/pkg/dynamic/Mapbox.framework/Headers/MGLShapeSource.h#L106 – with the right line numbers but a nonexistent path.

/cc @ericrwolfe

@1ec5 1ec5 added bug documentation iOS Mapbox Maps SDK for iOS labels Jan 1, 2017
@1ec5 1ec5 added this to the ios-v3.4.0 milestone Jan 1, 2017
@1ec5
Copy link
Contributor Author

1ec5 commented Jan 1, 2017

No matter what we use as the source for jazzy, we’re going to wind up with incorrect URLs (either the paths or the line numbers). Here’s a possible alternative:

  1. Copy the examples to the original headers to be checked in.
  2. Revert the changes to jazzy.yml and document.sh.
  3. Keep the unit tests. Add a unit test that ensures the headers are in sync with the tests (by comparing the headers’ contents to the test file’s contents).

@1ec5
Copy link
Contributor Author

1ec5 commented Jan 8, 2017

Fixed in #7569 on the release-ios-v3.4.0 branch.

@1ec5 1ec5 closed this as completed Jan 8, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug documentation iOS Mapbox Maps SDK for iOS
Projects
None yet
Development

No branches or pull requests

1 participant