Documentation Improvements #525
Open
Conversation
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
# Conflicts: # lib/buildtools/src/build/__tests__/all.test.ts # lib/lintplugin/package.json # lib/modules-lib/src/tabs/__tests__/useAnimation.test.ts # package.json # yarn.lock
…y it as a dependency
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
Comment on lines
313
to
323
| * Including 0 and 1, there are `num + 1` evenly spaced sample points | ||
| * @return function of type Curve → Drawing | ||
| * @returns function of type Curve → Drawing | ||
| * @example | ||
| * ``` | ||
| * draw_3D_connected_full_view_proportional(100)(t => make_3D_point(t, t, t)); | ||
| * ``` | ||
| */ | ||
| export const draw_3D_connected_full_view_proportional = createDrawFunction( | ||
| 'fit', | ||
| 'lines', | ||
| '3D', | ||
| false | ||
| ); | ||
| export const draw_3D_connected_full_view_proportional = RenderFunctionCreators.draw_3D_points_full_view_proportional; | ||
|
|
||
| /** | ||
| * Returns a function that turns a given 3D Curve into a Drawing, by sampling |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Comment on lines
-56
to
66
| g: number, | ||
| b: number | ||
| ): Point { | ||
| r = clamp(r, 0, 255); | ||
| g = clamp(g, 0, 255); | ||
| b = clamp(b, 0, 255); | ||
|
|
||
| return new Point(x, y, 0, [r / 255, g / 255, b / 255, 1]); | ||
| } | ||
| export const make_color_point = CurveFunctions.make_color_point; | ||
|
|
||
| /** |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Comment on lines
+378
to
+384
| drawer: RenderFunction, | ||
| func: CurveAnimation | ||
| ): AnimatedCurve { | ||
| if (drawer.is3D) { | ||
| throw new Error(`${animate_curve.name} cannot be used with 3D draw function!`); | ||
| } | ||
|
|
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Comment on lines
-257
to
-263
| const mat = [ | ||
| [ | ||
| cthz * cthy, | ||
| cthz * sthy * sthx - sthz * cthx, | ||
| cthz * sthy * cthx + sthz * sthx | ||
| ], | ||
| [ |
There was a problem hiding this comment.
Bug: The draw_3D_connected_full_view_proportional function incorrectly renders points instead of connected lines due to a wrong function assignment.
Severity: HIGH
Suggested Fix
In src/bundles/curve/src/drawers.ts, change the assignment for draw_3D_connected_full_view_proportional to point to RenderFunctionCreators.draw_3D_connected_full_view_proportional instead of RenderFunctionCreators.draw_3D_points_full_view_proportional.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.
Location: src/bundles/curve/src/functions.ts#L257-L263
Potential issue: The function `draw_3D_connected_full_view_proportional` is incorrectly
assigned to `RenderFunctionCreators.draw_3D_points_full_view_proportional`. As a result,
when a user calls `draw_3D_connected_full_view_proportional`, the system will render a
set of disconnected points instead of the expected connected line segments. This leads
to an incorrect visualization that does not match the function's intended behavior.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
PR for a bunch of miscellaneous changes focused mainly around improving documentation.
booleanin the documentation so as not to confuse cadetstscfunctions into two different commandslodashdependency declared@blueprintjs