1
0
Fork 0
Commit graph

234 commits

Author SHA1 Message Date
joostdecock
a30b08371c feat(core): Added Path.combine and related changes, closes #5976
The discussion in #5976 is whether `Path.join()` should use a line
segment to close any gaps in the path caused by move operations, or by
differences in the end and start points of paths being joined.

The answer is yes, that is the intended behaviour, but people who read
_join_ might expect differently.

So I have made a few changes to clarify this:

- The new `Path.combine()` method combines multiple path instances into
  a single instance without making any changes to the drawing operations
- Since `Path.combine()` is variadic, I have also updated `Path.join()`
  to be variadic too, since that is more consistent.
- The old way of calling `Path.join(path, bool)` is deprecated and will
  log a warning. Calling `Path.join()` this way will be removed in v4.
- Related to this change is how `Path.length()` should behave when there
  are gaps in the path. Currently, it skips those. So I've added a
  parameter that when set to `true` will include them.
- Added documentation for `Path.combine()`
- Updated documentation for `Path.join()`
- Updated documentation for `Path.length()`
2024-02-10 15:40:41 +01:00
Joost De Cock
6c0a579a35
Merge pull request #5899 from BenJamesBen/add-svg-render-doc
chore(markdown): Add Svg.render() documentation
2024-02-03 17:10:07 +01:00
Joost De Cock
1b2605c274
Merge pull request #5930 from BenJamesBen/readmore-remove-list-attribute
fix(markdown): Remove unused list attribute from ReadMore tags
2024-01-30 19:11:34 +01:00
Joost De Cock
4bd94950fd
Merge pull request #5931 from BenJamesBen/extend-options-doc
fix(markdown): Add more info to Extending Options part doc
2024-01-30 19:11:06 +01:00
Benjamin Fan
576f1e5baf fix(markdown): Add cbqc and goldenRatio links and info to core API 2024-01-29 15:40:33 -08:00
Benjamin Fan
06b460cf9c fix(markdown): Add more info to Extending Options part doc 2024-01-29 14:03:04 -08:00
Benjamin Fan
83ae88c5d5 fix(markdown): Remove unused list attribute from ReadMore tags 2024-01-29 08:43:38 -08:00
Benjamin Fan
c5498b93f5 chore(markdown): Document Svg.render() as a mostly-internal method 2024-01-27 07:06:19 -08:00
Benjamin Fan
21cca5e270 fix(markdown): Fix Svg.asRenderProps() documentation grammar 2024-01-24 20:21:08 -08:00
Benjamin Fan
9593e8d078 chore(markdown): Add Svg.render() documentation 2024-01-24 20:20:10 -08:00
Benjamin Fan
5828e53937 fix(core): Remove Svg.body property 2024-01-24 20:18:03 -08:00
Benjamin Fan
4d404dd3cc fix(markdown) Fix typos 2024-01-21 11:16:40 -08:00
Wouter van Wageningen
be24625373
Merge pull request #17 from freesewing/develop
catchup
2024-01-08 22:34:30 -08:00
joostdecock
42a4d39807 fix(markdown): Remove stack example 2024-01-07 17:25:07 +01:00
Wouter van Wageningen
e22b97c18a
Update freesewing/markdown/dev/reference/api/part/config/dependencies/en.md
Missing 'r' in 'From:'
2024-01-05 13:19:16 -08:00
Thrunic
4ecbbbddb0 Replaced path.addClass(...) with path.setClass(...) in the example. 2023-12-08 13:28:42 -05:00
joostdecock
dae323b697 fix(markdown): Broken links. Closes #5463 2023-11-12 11:13:38 +01:00
joostdecock
e35bda36f7 chore(markdown): Changes to refer less to models 2023-10-30 19:27:24 +01:00
joostdecock
6b147d81a0 feat(markdown): New docs for various things 2023-10-29 17:20:35 +01:00
joostdecock
4f15648d15 feat(markdown): Document defs. Closes #4075 2023-10-29 11:51:13 +01:00
joostdecock
e1dbff5c6e chore(markown): Update shorthand docs. Closes #4077 2023-10-29 10:20:05 +01:00
Yash-Ambekar
9545062cab replaced the url to Point object to relative path 2023-10-28 13:34:40 +05:30
Yash-Ambekar
7ed4d4e249 added documentation to two new methods in the utils section of API 2023-10-27 23:58:35 +05:30
Joost De Cock
9aeff4322f wip(markdown): Add missing core methods 2023-10-21 14:48:06 +02:00
Joost De Cock
05fd153237 feat(markdon): Document missing named exports in core 2023-10-21 13:23:32 +02:00
Joost De Cock
828c62c9db chore(markdown): Bespoke, not made-to-measure 2023-10-21 11:46:17 +02:00
Joost De Cock
5b9eafe67c
Merge pull request #4009 from BenJamesBen/stacks-documentation
chore(docs): Add Stack documentation
2023-10-14 16:49:22 +02:00
Joost De Cock
304b1f8ea0
Merge pull request #4089 from BenJamesBen/optionalMeasurements-docs-update
fix(docs): Move optional measurements info from Part config to Part draft
2023-10-14 16:47:27 +02:00
joostdecock
28bccbaaf9 feat(markdown): Added docs for new core methods 2023-06-21 11:59:10 +02:00
joostdecock
a532a6e010 feat(markdown): Docs for utils.mergeOptions() 2023-06-11 15:57:16 +02:00
Joost De Cock
bd50aae150
Merge pull request #4202 from freesewing/serialize
feat(core): Added Pattern.getLogs() and updated Pattern.getRenderProps()
2023-06-02 14:25:24 +02:00
joostdecock
57d50c42da feat(markdown): Docs for new/updated core methods 2023-06-01 16:48:11 +02:00
Benjamin Fan
62a922d324 fix(docs): (stacks) Change Pattern Guide link to new Design Guide 2023-05-31 21:44:58 -07:00
Benjamin Fan
a1106226fe fix(docs): (stacks) Updates from doc review 2023-05-31 21:39:58 -07:00
Benjamin F
8fbb41fca7 chore(docs): (stacks) Cross-reference API and pattern guide docs 2023-05-31 21:39:58 -07:00
Benjamin F
485a29b393 chore(docs): Added stack info to part configuration docs 2023-05-31 21:39:58 -07:00
Benjamin F
96ced472e4 chore(docs): Add Stack documentation 2023-05-31 21:39:58 -07:00
Benjamin Fan
10d1099f55 fix(docs): (snap) Metric/imperial properties can hold a number, in addition to holding an array 2023-05-26 15:30:26 -07:00
Benjamin F
32d2aa9b36 fix(docs): Move optional measurements info from Part config to Part draft 2023-05-18 14:34:16 -07:00
Joost De Cock
b1ec35b73c
Merge pull request #3974 from BenJamesBen/optional-measurements
fix(bob,penelope,docs): Access optional measurements via `measurements`
2023-05-18 08:49:05 +02:00
Benjamin F
614a3f8c9c fix(docs): Remove sample setting info from Pattern.sample() 2023-05-03 20:43:13 -07:00
Benjamin F
b5371f0b5c fix(docs): Clarify how optional measurements are accessed 2023-05-03 18:48:32 -07:00
Wouter van Wageningen
a5f141a586 Docs and code cleanup 2023-04-28 18:26:55 +00:00
Wouter van Wageningen
486fde8b67 Documentation 2023-04-28 17:49:19 +00:00
Zee
1a17bce223
Update en.md
White space
2023-04-25 17:57:39 +02:00
Zee
421dd1cbc7 grammar fix 2023-04-25 15:53:01 +00:00
Zee
8d4b601688 incorporates marpants suggestions 2023-04-21 12:58:37 +00:00
Zee
8cfb5342bf fixes attr and props 2023-04-16 17:34:13 +00:00
Zee
92980289e5 expands slope documentation slightly 2023-04-16 16:51:14 +00:00
Zee
b5b65b82b7 adds salient example to point.slope 2023-04-16 16:39:13 +00:00