-
Notifications
You must be signed in to change notification settings - Fork 0
add docc root page #35
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a new docc root page for EnvironmentDecoder along with an update to the README to include a detailed documentation link.
- Added a new documentation page (EnvironmentDecoder.md) with usage examples and detailed information.
- Updated the README to reference detailed documentation on the Swift Package Index.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Sources/EnvironmentDecoder/EnvironmentDecoder.docc/EnvironmentDecoder.md | New doc page detailing usage, examples, and error handling. |
| README.md | Added a documentation link and brief instructional text. |
Comments suppressed due to low confidence (1)
Sources/EnvironmentDecoder/EnvironmentDecoder.docc/EnvironmentDecoder.md:6
- The word 'builing' appears to be a typo. Consider correcting it to 'building'.
Suppose you're builing a server app and want to enable specifying the port to bind to in the environment. ...
Sources/EnvironmentDecoder/EnvironmentDecoder.docc/EnvironmentDecoder.md
Outdated
Show resolved
Hide resolved
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #35 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 4 4
Lines 590 590
=========================================
Hits 590 590 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
03d32be to
4348001
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a new documentation page for EnvironmentDecoder and updates the README with a link to detailed documentation.
- Adds a new docc root page for EnvironmentDecoder with comprehensive usage examples.
- Updates the README to include a link to detailed documentation on the Swift Package Index.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Sources/EnvironmentDecoder/EnvironmentDecoder.docc/EnvironmentDecoder.md | New documentation page detailing usage, examples, mapping, supported data types, error handling, and alternative environment options. |
| README.md | Added a link to detailed documentation to help users get started quickly. |
Comments suppressed due to low confidence (1)
Sources/EnvironmentDecoder/EnvironmentDecoder.docc/EnvironmentDecoder.md:6
- There is a typo in 'builing' which should be corrected to 'building'.
Suppose you're builing a server app and want to enable specifying the port to bind to in the environment. You might write something like this:
4348001 to
05e3650
Compare
No description provided.