Update project documentation for new state of the world #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mordil
added
documentation
santicarmo31
reviewed
Jan 8, 2025
| @@ -61,6 +61,7 @@ extension String.StringInterpolation { | |||
| /// - value: The value to localize. If the value is `nil`, then the `nilDescription` will be used. | |||
| /// - locale: The Locale to localize the value for. The default is `.current`, ig. the runtime environment's Locale. | |||
| /// - nilDescription: The optional description to use when the `value` is `nil`. | |||
| @_documentation(visibility: private) | |||
There was a problem hiding this comment.
If we are exposing the function why are we hiding its documentation?
There was a problem hiding this comment.
Because of quirks with DocC and its generation.
We show this exists for people in documentation, and have symbol docs for code completion, but generally these methods aren’t able to be accessed directly - so there’s no point in listing it in the main side bar
There was a problem hiding this comment.
Makes sense. Personally do not think people will use the interpolation methods since they are hard to "discover"
santicarmo31
approved these changes
Jan 8, 2025
|
Latest push was a rebase for squashing fixes to the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
A hallmark of a good library is its documentation, and much of the library was re-written. The documentation needs to be updated to avoid giving incorrect information to developers, but also can be made more robust by going in depth on certain topics.
In addition, the README needed to be updated for several broken links and new infrastructure in use such as for GitHub Actions and Swift Package Index documentation hosting.
Modifications:
CurrencyDescriptorResult:
Developers looking to learn about the library and its concepts should have a more straight forward and clear understanding from within our code base itself.