refactor(examples): Examples overhaul #490

kaosat-dev · 2019-12-16T09:35:45Z

This pr overhauls all the examples:

V2 API
more clear
more specific examples
docstrings & explanations
etc

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Does your submission pass tests?

…scad to .js

… example, to cover potential issues

* moved a few of them to better folders * upgrading to es6 + V2 * particularly focusing on solidFromSlices/extrudeFromSlices

better structure, and more idiomatic v2

z3dev · 2020-08-04T07:22:12Z

@kaosat-dev you seem to be pretty remote these days, so there will be additional contributions to this PR. if you happen to read this then can you commit the most recent changes? thanks

z3dev · 2020-08-26T00:19:06Z

Quick comment...

web/package.json includes @jscad/examples as a 'dependency', which is incorrect. this package should be a 'devDependency'.

SimonClark · 2020-09-01T19:01:09Z

@z3dev I think these are in pretty good shape now for alpha release. Please review, and give me an comments.

All the basics are covered, but some of the more complex examples are still awaiting some attention. Those remain in the 'old' folder, and can come later.

z3dev · 2020-09-01T22:33:15Z

@SimonClark super job!

I’ve been following along, and running examples. : )

I’ll do a more formal review of the code. It might take a day or two.

…issues in examples

packages/web/src/ui/views/examples.js

z3dev

Some of the new examples are really cool. Thanks for taking this task on.

Some minor changes have been requested. I suggest running lint on the examples and cleaning up the code to meet standards.

As you make changes to close requests, please RESOLVE the request. I will review again once you are finished.

packages/examples/core/booleans/basicBooleans.js

packages/examples/core/colors/colorCube.js

packages/examples/core/colors/transparency.js

packages/examples/core/curves/bezier/extrudeAlongPath.js

packages/examples/parameters/gear.js

packages/modeling/src/curves/bezier/tangentAt.js

packages/modeling/src/operations/extrusions/extrudeRotate.js

packages/web/src/ui/views/examples.js

packages/examples/parameters/allParamTypes.js

z3dev

Vastly improved examples. Thanks again.
I found a few things to change, then let’s merge for Alpha version.

z3dev · 2020-09-07T12:10:11Z

Opened issue #676 to track a new task for the examples.

Here’s a comparison of comments versus JSDOC tags. Really close.

Comments (current):

Author
Description
File
From (@see URL)
Level @Property ??
License
Tags (@see API function)
Title (@summary)

Comments (JSDOC)

@author : Identify the author(s) of an item.
@copyright : Document some copyright information.
@description : A full general description.
@file : Describe a file. (Use at start of file)
@license : Identify the license that applies to this code.
@see : Refer to some other documentation for more information.
@summary : A shorter version of the full description. (For doclets)
{@link} : Link to another item in the documentation.

z3dev · 2020-09-07T22:08:16Z

@SimonClark this looks like a good start for the examples. Any further changes coming?

SimonClark

@SimonClark this looks like a good start for the examples. Any further changes coming?

I got nothing planned imminently. Ship it!

packages/examples/core/hulls/hull.js

packages/examples/parameters/allParamTypes.js

packages/modeling/src/curves/bezier/tangentAt.js

z3dev

ALPHA version is done!!!

AWESOME!!!

kaosat-dev added 14 commits January 28, 2020 15:48

refactor(examples): renamed a few examples, changed extension from .j…

69d8573

…scad to .js

refactor(examples): overhauled chainHull example (first pass)

68ffe49

refactor(examples): renamed for coherence

330a587

refactor(examples): continued examples upgrade & overhaul

e504a64

refactor(examples): continued overhaul work

218f8f7

feature(examples): added examples for measurements

bf50f0a

feat(examples): overhauled/added examples for expand/offset

fe70ebe

chore(examples): tweaks to expand/offset

164cc48

refactor(examples): updated/ cleaned up colors examples a bit

4faa4c7

feat(examples): added new & clean V2 examples for color

0bc546e

refactor(examples): small cleanups

4d0ab74

chore(examples): added require()ing from subfolder for modular design…

118fa6c

… example, to cover potential issues

refactor(examples): continued cleanup/refactor of examples

924047b

* moved a few of them to better folders * upgrading to es6 + V2 * particularly focusing on solidFromSlices/extrudeFromSlices

refactor(examples): overhauled module-design example for more clarity,

d18a915

better structure, and more idiomatic v2

kaosat-dev force-pushed the examples-overhaul branch from 41ce1fe to d18a915 Compare January 28, 2020 21:17

SimonClark added 14 commits August 5, 2020 07:15

Merge branch 'V2' into examples-overhaul

35ed296

Updating color examples.

f64fee0

Updating expand.js

21f2dda

Re-arrange examples to place non-working files into 'old' directory

f80279d

Updating core primitives examples for V2

742ff14

interim updates to parameter and extrude examples

67f3055

Merge branch 'V2' into examples-overhaul

f07a28a

Merge branch 'V2' into examples-overhaul

fd92636

updated examples for new transform order

4cc950f

parameters/gears.js working

a68d757

Merge branch 'V2' into examples-overhaul

bb2241c

Updated parameters/balloons.js, moved to current examples folder.

51e351c

Adding basicBoolean and allParams examples

e03670e

WIP atl import example

9b53e70

SimonClark added 2 commits August 23, 2020 22:22

Merge branch 'V2' into examples-overhaul

dcc3b6d

Updating module-design example

3eee1ec

SimonClark added 6 commits August 26, 2020 08:43

Adding Text and Center examples

f782676

Adding hull example, fixing center example.

00c4571

Adding STL and SVG import examples

e7e4922

Adding AMF import example

f5734e1

Adding MeasureAreaAndVolume example

03fab03

Adding MeasureBoundingBox example

3ae59a8

SimonClark added 2 commits September 1, 2020 16:54

deleting testV2.js

f15c334

Removing comment for dodecahedron

97868f5

SimonClark added 2 commits September 2, 2020 11:46

Merge branch 'V2' into examples-overhaul

2d04f69

Update examples.js to reference current files. Fix a couple of minor …

366ee0a

…issues in examples

SimonClark reviewed Sep 3, 2020

View reviewed changes

packages/web/src/ui/views/examples.js Show resolved Hide resolved

z3dev requested changes Sep 4, 2020

View reviewed changes

Tweaks to examples

bbe6a92

z3dev reviewed Sep 6, 2020

View reviewed changes

packages/examples/parameters/allParamTypes.js Outdated Show resolved Hide resolved

z3dev requested changes Sep 6, 2020

View reviewed changes

Adding hull2D example, More Tweaks to examples

77a3d71

SimonClark approved these changes Sep 7, 2020

View reviewed changes

packages/examples/core/hulls/hull.js Outdated Show resolved Hide resolved

packages/examples/parameters/allParamTypes.js Outdated Show resolved Hide resolved

packages/modeling/src/curves/bezier/tangentAt.js Show resolved Hide resolved

z3dev approved these changes Sep 7, 2020

View reviewed changes

z3dev merged commit d73e06f into V2 Sep 7, 2020

z3dev deleted the examples-overhaul branch September 25, 2020 03:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(examples): Examples overhaul #490

refactor(examples): Examples overhaul #490

kaosat-dev commented Dec 16, 2019 •

edited by z3dev

Loading

z3dev commented Aug 4, 2020

z3dev commented Aug 26, 2020

SimonClark commented Sep 1, 2020

z3dev commented Sep 1, 2020

z3dev left a comment

z3dev left a comment

z3dev commented Sep 7, 2020 •

edited

Loading

z3dev commented Sep 7, 2020

SimonClark left a comment

z3dev left a comment

refactor(examples): Examples overhaul #490

refactor(examples): Examples overhaul #490

Conversation

kaosat-dev commented Dec 16, 2019 • edited by z3dev Loading

All Submissions:

z3dev commented Aug 4, 2020

z3dev commented Aug 26, 2020

SimonClark commented Sep 1, 2020

z3dev commented Sep 1, 2020

z3dev left a comment

Choose a reason for hiding this comment

z3dev left a comment

Choose a reason for hiding this comment

z3dev commented Sep 7, 2020 • edited Loading

z3dev commented Sep 7, 2020

SimonClark left a comment

Choose a reason for hiding this comment

z3dev left a comment

Choose a reason for hiding this comment

kaosat-dev commented Dec 16, 2019 •

edited by z3dev

Loading

z3dev commented Sep 7, 2020 •

edited

Loading