Skip to content

Fixes for the 'Basic Usage' to allow project to build and run #1507

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

Merged
merged 7 commits into from
Oct 17, 2022
Merged

Fixes for the 'Basic Usage' to allow project to build and run #1507

merged 7 commits into from
Oct 17, 2022

Conversation

sillygoose
Copy link
Contributor

New to TCA (and Swift for that matter) and was just building the Basic Usage section and ran into some minor errors, these minor changes correct the steps so you can build and run the example.

Using the latest Xcode and Swift 5.7 and the new TCA ReducerProtocol builds. Key changes are:

  • 'number' was undefined in the numbersapi.com code and complier flagged 'using' as an error
  • wrapping the FeatureView() in a WindowGroup to fix errors
  • sample didn't work since my simulator flagged using HTTP, since there is no HTTPS support added an exception to allow API requests to work.

README.md Outdated
}
}
```

You may also find that the HTTP API request to numbersapi.com is blocked as only HTTPS connections are permitted. If this happens you can add an exception to the project settings to allow HTTP requests just for the numbersapi.com domain.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be a lot of unrelated information to display inline in a README. If it stays in the final version of this PR, it would probably be better to be hidden in a details/summary tag:

<details>
  <summary>
  About `http://numbersapi.com`
  </summary>
  You may also find that the HTTP API request to […]
</details>

But I think it can probably go away, so please wait for other's feedback before making drastic changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, let this go which just leaves minor changes to using the samples in a cut/paste fashion

tgrapperon added a commit to tgrapperon/swift-composable-architecture that referenced this pull request Oct 15, 2022
stephencelis pushed a commit that referenced this pull request Oct 15, 2022
Co-authored-by: Brandon Williams <[email protected]>
Copy link
Member

@stephencelis stephencelis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! We'll take most of these 😄 Just omitting one to keep things generally simple and with an aim to avoid the confusion entirely in the future.

@stephencelis stephencelis merged commit e726a13 into pointfreeco:main Oct 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants