docs(axis): document logMapping and logLinearWidth for log axes#518
Open
netscout-mthorn wants to merge 1 commit into
Open
docs(axis): document logMapping and logLinearWidth for log axes#518netscout-mthorn wants to merge 1 commit into
netscout-mthorn wants to merge 1 commit into
Conversation
9 tasks
This file contains hidden or 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
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.
Summary
logMapping(string) = 'none'option docs toen/option/component/axis-common.md:documents the three values (
'none','asinh','symlog'), tick placementbehaviour, the
splitNumberinteraction, and thealignTickslimitation.logLinearWidth(number) = 1option docs: explains the quasi-linear regionhalf-width shared by both
'asinh'and'symlog'modes and its effect on thelinear-to-log transition.
logBasedescription to clarify that whenlogMappingis'asinh'or'symlog',logBasecontrols tick spacing rather than the transform itself.splitNumberdescription to note that forlogMappingaxes, it controlshow many power-of-base tick candidates are shown, with automatic skipping of
intermediate powers when the range would produce too many.
All changes are in the shared axis partial (
axis-common.md), so they apply toxAxis,yAxis,angleAxis,radiusAxis,singleAxis, andparallelAxiswithoutduplication.
Not included
zh/option/component/axis-common.md): I attemptednode tool/patchLanguage --from=en --to=zhbut it fails withCannot find module '../editor/common/blockHelper'. This appears to be aninternal dependency not available in the public repo. I am not able to provide
a Chinese translation. If a committer is able to apply it, or can advise on the
expected process for external contributors, that would be appreciated.
Related
Checks
npm run build: passesQuestions for reviewers
The version badges on
logMappingandlogLinearWidthare currently set to6.2.0. Is that the correct target version for this feature, or should theybe updated?
The doc text references d3 and matplotlib in two places:
symlogdescription: "This is the symlog transform used by matplotlib and d3."logLinearWidthdescription: "The default of1matches the conventions used by d3'sscaleAsymlogand matplotlib'sAsinhScale."The only existing d3 references in this repo (
geo-common.md) are functional: they tell users they can use d3-geo directly with theprojectionAPI. The references above are citation-style, which has no clear precedent here. Is it appropriate to keep them? A possible middle ground: keep thesymlogsentence (it names the term's origin, which aids recognition) and drop thelogLinearWidthcitation in favour of simply "The default is1."