Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #673 duplicate callouts #697

Merged
merged 4 commits into from
Dec 12, 2016
Merged

Fix #673 duplicate callouts #697

merged 4 commits into from
Dec 12, 2016

Conversation

SDGGiesbrecht
Copy link
Contributor

@SDGGiesbrecht SDGGiesbrecht commented Dec 11, 2016

Fixed #673 by normalizing capitalization before filtering special callouts (Parameter, Returns). Also added the callout Parameters for consistency. (See the list of callouts in Swift’s API Design Guidelines)

You can run the following commands to see the problem. (You’ll have to manually expand one of the functions once the documentation pops up.)

git clone https://github.com/SDGGiesbrecht/SDGLogic
cd SDGLogic
swift package generate-xcodeproj
jazzy
open docs/Functions.html
cd ..

Run the commands again with jazzy built from this branch and you will see that the duplicate callouts are gone.

@DangerCI
Copy link

DangerCI commented Dec 11, 2016

1 Warning
⚠️ This PR may need tests.

Generated by 🚫 danger

@SDGGiesbrecht
Copy link
Contributor Author

SDGGiesbrecht commented Dec 11, 2016

I rearranged the code slightly to pass RuboCop.

@pigeondotdev
Copy link
Contributor

Thanks for filing this PR! Everything looks good to me but I'll let @jpsim or someone else merge this one in. 😸

@jpsim
Copy link
Collaborator

jpsim commented Dec 12, 2016

Thanks for the PR @SDGGiesbrecht!

@jpsim jpsim merged commit 01724fe into realm:master Dec 12, 2016
@SDGGiesbrecht SDGGiesbrecht deleted the fix-673-duplicate-callouts branch December 12, 2016 22:41
1ec5 pushed a commit to realm/jazzy-integration-specs that referenced this pull request Jan 9, 2017
The changes in realm/jazzy#697 removed duplicated callouts and modified
the content of the siesta fixture, but did not update the integration spec.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants