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

[ios, macos] Add testing for code in guides #8461

Closed
jmkiley opened this issue Mar 17, 2017 · 3 comments · Fixed by #8910
Closed

[ios, macos] Add testing for code in guides #8461

jmkiley opened this issue Mar 17, 2017 · 3 comments · Fixed by #8910
Assignees
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS tests
Milestone

Comments

@jmkiley
Copy link
Contributor

jmkiley commented Mar 17, 2017

We should add a separate test file for the code that lives in our SDK guides, or discuss other methods of testing code snippets.

cc @friedbunny

@jmkiley jmkiley added documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS labels Mar 17, 2017
@jmkiley jmkiley added this to the ios-v3.5.1 milestone Mar 17, 2017
@friedbunny
Copy link
Contributor

friedbunny commented Mar 17, 2017

See @ericrwolfe’s #8354 (comment) for more information about other examples testing that’s already happening.

We might be able to rework the original script from this PR #7337 to scan through the guides directory and replace placeholder tokens in the markdown files.

@1ec5
Copy link
Contributor

1ec5 commented Mar 18, 2017

The original script from #7337 looks suitable for this purpose. It can be much simpler than the one we use to insert example code into the headers, because the guide’s .md.ejs can mark the insertion point with an HTML comment that the developer never sees. By contrast, anything we put in the headers is visible to the developer, so that script needed a bit of Swift syntax awareness to figure out the insertion point for itself.

@boundsj boundsj modified the milestones: ios-v3.6.0, ios-v3.5.1 Mar 22, 2017
@boundsj
Copy link
Contributor

boundsj commented Mar 22, 2017

@jmkiley I'm moving this to the 3.6.0 milestone since it does not seem critical for a patch release. Please feel free to put it back if it looks like it'll be completed soon!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS tests
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants