Article descriptions - Add casing warning label for non-EN wikis #3883
Conversation
|
Should this be based off this PR? |
|
This is waiting on #3880 to be merged. |
|
This is ready for review. |
| guard let firstCharacter = description?.first, | ||
| firstCharacter.isLetter, | ||
| firstCharacter.isUppercase else { | ||
| return warningTypes | ||
| } | ||
|
|
||
| warningTypes.insert(.casing) |
There was a problem hiding this comment.
To me, it's more readable if something like this. Personal preference though.
| guard let firstCharacter = description?.first, | |
| firstCharacter.isLetter, | |
| firstCharacter.isUppercase else { | |
| return warningTypes | |
| } | |
| warningTypes.insert(.casing) | |
| if let firstCharacter = description?.first, | |
| firstCharacter.isLetter, | |
| firstCharacter.isUppercase { | |
| warningTypes.insert(.casing) | |
| } |
There was a problem hiding this comment.
@mcleinman done!
| @@ -14,8 +21,16 @@ protocol ArticleDescriptionControlling { | |||
| func currentDescription(completion: @escaping (String?) -> Void) | |||
| func errorTextFromError(_ error: Error) -> String | |||
| func learnMoreViewControllerWithTheme(_ theme: Theme) -> UIViewController? | |||
| var descriptionMaxLength: Int { get } | |||
There was a problem hiding this comment.
Not a bug, but not sure you need this line - I think you can get away with just having the variable int he protocol extension if you want. This is definitely a personal style preference, please feel very free to disagree.
There was a problem hiding this comment.
@mcleinman yep agreed, I don't see the reason to keep it here if we're not overriding/swapping out the implementation anywhere.
| } | ||
|
|
||
| extension ArticleDescriptionControlling { | ||
| var articleDisplayTitle: String? { return article.displayTitle } | ||
| var descriptionMaxLength: Int { return 90 } | ||
|
|
||
| func descriptionIsTooLong(_ description: String?) -> Bool { |
There was a problem hiding this comment.
We have descriptionIsTooLong in the extension, but the "check capitalization of first letter" function lives in a class. Maybe we should standardize this? Either all the check functions can be in here, or none?
There was a problem hiding this comment.
@mcleinman sounds good, I have moved the capitalization check into the extension. Originally descriptionIsTooLong was just code used in both classes, so I moved it to an extension to share code. Since the capitalization logic was only used in one place there was less of a need, but it feels better now that they're matching.
| if let firstCharacter = description?.first, | ||
| firstCharacter.isLetter, | ||
| firstCharacter.isUppercase { | ||
| return true | ||
| } | ||
|
|
||
| return false |
There was a problem hiding this comment.
Could be more concise if you wanted:
guard let firstCharacter = description?.first else {
return false
}
return firstCharacter.isLetter && firstCharacter.isUppercase
(I think I remember us talking about providing more detailed PR suggestions. If I'm wrong or you don't like this, don't worry about it - works great as is. Just let me know to stand down. :) )
There was a problem hiding this comment.
Sounds good, this is done!
Fixes Phabricator ticket: https://phabricator.wikimedia.org/T261977
Notes
This adds an extra warning label for users that begin their non-EN wiki article descriptions with a lowercase letter. It does not block publishing though, in case they are starting with a proper noun. Do not review until #3880 is merged and this PR is updated with
mainto clean up the diff.Test Steps
Screenshots/Videos (if applicable)
(Non-EN examples)
