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

docs: remove references to ready in docstrings #1210

Merged
merged 1 commit into from Jan 11, 2023
Merged

Conversation

samestep
Copy link
Collaborator

Description

#1188 deleted ready from @penrose/optimizer; this PR deletes lingering references to it from a couple docstrings.

Checklist

  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new ESLint warnings
  • I have reviewed any generated registry diagram changes

@github-actions
Copy link

± Registry diff

📊 Performance

Key

Note that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms.

     0s   1s   2s   3s   4s   5s   6s   7s   8s   9s
     |    |    |    |    |    |    |    |    |    |
name ▝▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▞▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▖
      compilation labelling optimization rendering

Data

                                        0s   1s   2s   3s   4s   5s   6s   7s   8s
                                        |    |    |    |    |    |    |    |    |
3d-projection-fake-3d-linear-algebra    ▝▀▞▖
allShapes-allShapes                     ▝▀▀▞▄▄▄
arrowheads-arrowheads                   ▝▀▞▖
caffeine-structural-formula             ▝▀▀▀▀▀▀▀▀▀▞▚
center-shrink-circle-animation          ▝▞▖
circle-example-euclidean                ▝▀▀▀▀▚▀▀▀▖
collinear-euclidean                     ▝▀▀▀▚▚
congruent-triangles-euclidean           ▝▀▀▀▀▀▀▀▀▚▚
continuousmap-continuousmap             ▝▀▞▖
hypergraph-hypergraph                   ▝▀▀▀▀▀▀▀▀▀▀▀▞▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▖
incenter-triangle-euclidean             ▝▀▀▀▀▚▚
lagrange-bases-lagrange-bases           ▝▀▚▚
midsegment-triangles-euclidean          ▝▀▀▀▚▚
non-convex-non-convex                   ▝▀▀▀▚▚
one-water-molecule-atoms-and-bonds      ▝▚▚
parallel-lines-euclidean                ▝▀▀▀▀▞▖
persistent-homology-persistent-homology ▝▀▀▀▀▀▀▞▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▖
points-around-line-shape-distance       ▝▀▀▀▞▖
points-around-polyline-shape-distance   ▝▀▀▀▀▀▀▀▀▀▀▚▚
points-around-star-shape-distance       ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▚
siggraph-teaser-euclidean-teaser        ▝▀▀▀▀▀▞▖
small-graph-disjoint-rect-line-horiz    ▝▀▀▀▀▀▀▀▀▀▞▖
small-graph-disjoint-rects              ▝▀▞▖
small-graph-disjoint-rects-large-canvas ▝▀▞▖
small-graph-disjoint-rects-small-canvas ▝▀▞▖
tree-tree                               ▝▀▀▞▖
tree-venn                               ▝▀▀▀▞▖
tree-venn-3d                            ▝▀▀▚▚▄
two-vectors-perp-vectors-dashed         ▝▀▚▚
vector-wedge-exterior-algebra           ▝▀▚▚
wet-floor-atoms-and-bonds               ▝▀▀▞▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚
word-cloud-example-word-cloud           ▝▀▀▀▀▀▞▖
wos-laplace-estimator-walk-on-spheres   ▝▀▀▀▀▀▀▚▚
wos-nested-estimator-walk-on-spheres    ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▀▀▀▀▀▀▀▚
wos-offcenter-estimator-walk-on-spheres ▝▀▀▀▀▀▀▀▀▞▀▀▀▖
wos-poisson-estimator-walk-on-spheres   ▝▀▀▀▀▀▀▀▀▀▞▀▖

@codecov
Copy link

codecov bot commented Jan 11, 2023

Codecov Report

Merging #1210 (d4f8991) into main (cb3585d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1210   +/-   ##
=======================================
  Coverage   62.38%   62.38%           
=======================================
  Files          59       59           
  Lines        7111     7111           
  Branches     1660     1660           
=======================================
  Hits         4436     4436           
  Misses       2591     2591           
  Partials       84       84           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@samestep samestep merged commit a7aeadf into main Jan 11, 2023
@samestep samestep deleted the fix-ready-docstrings branch January 11, 2023 20:19
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.

None yet

1 participant