Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

document window #1349

Merged
merged 7 commits into from
Mar 20, 2023
Merged

document window #1349

merged 7 commits into from
Mar 20, 2023

Conversation

Fil
Copy link
Contributor

@Fil Fil commented Mar 17, 2023

remarks:

  • k is not optional
  • shift is deprecated
  • added the strict option to README

for #1343

remarks:
* *k* is not optional
* *shift* is deprecated
* added the *strict* option to README
@Fil Fil requested a review from mbostock March 17, 2023 10:02
@Fil Fil mentioned this pull request Mar 17, 2023
3 tasks
@Fil Fil changed the title document Plot.window document window Mar 17, 2023
src/transforms/window.d.ts Outdated Show resolved Hide resolved
src/transforms/window.d.ts Outdated Show resolved Hide resolved
src/transforms/window.d.ts Outdated Show resolved Hide resolved
src/transforms/window.d.ts Outdated Show resolved Hide resolved
Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tightened up the wording slightly, denoting the default parenthetically in the list, and split the paragraphs for the strict option to improve readability (since that was a bit long). I also clarified that the windowX and windowY transforms don’t just affect x and y respectively, they affect x, x1, and x2, and y, y1, and y2.

@mbostock mbostock merged commit d82fbfb into main Mar 20, 2023
@mbostock mbostock deleted the fil/ts-window branch March 20, 2023 16:47
chaichontat pushed a commit to chaichontat/plot that referenced this pull request Jan 14, 2024
* document Plot.window

remarks:
* *k* is not optional
* *shift* is deprecated
* added the *strict* option to README

* adopt @deprecated

* Update src/transforms/window.d.ts

Co-authored-by: Mike Bostock <[email protected]>

* Update src/transforms/window.d.ts

Co-authored-by: Mike Bostock <[email protected]>

* Update src/transforms/window.d.ts

Co-authored-by: Mike Bostock <[email protected]>

* Update src/transforms/window.d.ts

Co-authored-by: Mike Bostock <[email protected]>

* tweaks

---------

Co-authored-by: Mike Bostock <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants