This repository has been archived by the owner on Jul 11, 2024. It is now read-only.
Add complete documentation to the public interface #16
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
bcylin
approved these changes
Apr 4, 2019
| } | ||
|
|
||
| /// TBC | ||
| /// The following constants specify predefined format styles for list items. | ||
| @objc(LNListItemFormatterStyle) public enum Style: Int { |
There was a problem hiding this comment.
[nits] Maybe it's worth mentioning Mode and Style are for constructing the keys like standard, standardNarrow, and standardShort used in the plists?
There was a problem hiding this comment.
My original intention was to not mention any specifics on the underlying implementation but thinking about it, I don't see no harm so I'll give it a go 👍
| /// - Parameter list: TBC | ||
| /// - Returns: TBC | ||
| /// - Returns: A string representation of `list` formatted using the receiver’s | ||
| /// current settings. | ||
| @objc public func string(from list: [String]) -> String? { | ||
| return string(for: list) | ||
| } |
There was a problem hiding this comment.
[Q] Do you think it's a good idea to overload the method in Swift and expose a different name to Objective-C?
@objc(stringFrom:)
func string(for list: [String]) -> String?There was a problem hiding this comment.
Ahh I didn't think about this. I already opened #17 for improvements to the return value so can add this to that issue and tackle it separately to the documentation, thanks!
liamnichols
force-pushed
the
ln/document-interface
branch
from
467cf73 to
bf2c8bb
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #5