Remove subset of valid values from families attribute documentation
#2326
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
brentleyjones
approved these changes
Nov 15, 2023
BalestraPatrick
requested review from
keith,
luispadron,
mattrobmattrob and
thii
as code owners
mattrobmattrob
approved these changes
Nov 15, 2023
luispadron
approved these changes
Nov 15, 2023
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.
This is a bit of a documentation nitpick. Rules can have different supported families. The documentation for all rules was hardcoded to mention that valid values are only
iphoneandipadwhich isn't correct when looking atwatchos_*,tvos_*,visionos_*, andmacos_*rules.I simply vote for removing the list of valid values from the documentation for
_device_family_attrsgiven it is shared by all rules. We could specifically pass into this attribute the type of rule so that we can adapt the documentation for each platform to mention the allowed values, but I don't think it's really worth the complexity. Most rules only support one family (everything except iOS from my understanding), so people shouldn't really need to touch this attribute.