This repository has been archived by the owner on Aug 8, 2023. It is now read-only.
Override style specification documentation in runtime styling API #6107
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
frederoni
added
iOS
frederoni
added
the
⚠️ DO NOT MERGE
frederoni
force-pushed
the
5954-documentation-overrides
branch
7 times, most recently
from
719c227
to
d6ac418
Compare
| ${property.docs[property.values.indexOf(value)]} | ||
| */`; | ||
| } else { | ||
| return "#warning documentation missing."; |
There was a problem hiding this comment.
These warnings might be easier to track if they included the names of the enum values that are missing documentation.
1ec5
changed the title
frederoni
force-pushed
the
5954-documentation-overrides
branch
2 times, most recently
from
2b690a5
to
32c93dd
Compare
|
Rebased and cleaned. |
1ec5
suggested changes
Nov 2, 2016
| } | ||
|
|
||
| global.override = function(base, overrides) { | ||
| Object.keys(overrides).forEach(function(key) { |
There was a problem hiding this comment.
This can be expressed as a for-of loop:
for (var key of overrides) { … }| return (typeof object === 'object' && !Array.isArray(object)); | ||
| } | ||
|
|
||
| global.override = function(base, overrides) { |
There was a problem hiding this comment.
Instead of rolling our own function, import lodash and use _.assign() or _.assignIn().
| { | ||
| "layout_symbol": { | ||
| "icon-text-fit-padding": { | ||
| "doc": "Size of the additional area added to dimensions determined by `icon-text-fit`, in counterclockwise order: top, left, bottom, right." |
There was a problem hiding this comment.
How about:
Padding added to the dimensions determined by the
iconTextFitproperty.
We already mention in the generated documentation that the NSValue contains an NSEdgeInsets or UIEdgeInsets. The developer can look up what the expected order is for those types.
|
Some additional properties that we should fix:
It may be possible to fix these properties without an override, similar to how we replace “pixels” with “points”. |
frederoni
force-pushed
the
5954-documentation-overrides
branch
2 times, most recently
from
cfb587e
to
7c768b6
Compare
frederoni
force-pushed
the
5954-documentation-overrides
branch
from
7c768b6
to
b70babe
Compare
frederoni
removed
the
⚠️ DO NOT MERGE
1ec5
approved these changes
Nov 8, 2016
frederoni
force-pushed
the
5954-documentation-overrides
branch
from
b70babe
to
792d75b
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.
Fixes #5954 - Override some gl-style-spec documentation to make it more idiomatic.
👀 @1ec5 @friedbunny