docs(effect): add section for recurse api and clean up wording #2364
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 722c6c5:
|
| - **Supports Recursion:** | ||
| Recursion is supported with `set.recurse` for both sync and async use cases, but is not supported in the cleanup function. | ||
|
|
||
| <!-- prettier-ignore --> |
There was a problem hiding this comment.
What happens without it?
I think it's effective until the end. Is there a way to enable it back?
There was a problem hiding this comment.
I'm sorry, I don't understand what you are asking.
There was a problem hiding this comment.
If you are asking about prettier, prettier breaks the html layout for details arrows.
There was a problem hiding this comment.
Yes, I was asking about prettier. Maybe give up <details> for now?
There was a problem hiding this comment.
I think it's effective until the end.
Oh sorry, I missed a </details> above. I fixed it now.
There was a problem hiding this comment.
Yes, I was asking about prettier. Maybe give up
<details>for now?
I think the reader experience is good by initially hiding this additional information.
HTML elements in MDX is valid. The <!-- prettier-ignore --> only affects the next line. If removed, prettier adjusts the line spacing and indentation until MDX readers no longer parse this as HTML. Its too bad prettier doesn't have good support for this.
There was a problem hiding this comment.
The
<!-- prettier-ignore -->only affects the next line.
Oh, I see!
|
Something's up with the Vercel deployment, could you take a look? |
|
[10:47:43.151] Running build in Washington, D.C., USA (East) – iad1 . (87:0)
[10:47:55.535] [10:47:55.536] 85 | }) [10:47:55.536] 86 | }</code></pre> [10:47:55.536] > 87 | </li> [10:47:55.536] | ^ [10:47:55.536] 88 | <li parentName="ul"> [10:47:55.536] 89 | <p parentName="li"><strong parentName="p">{Supports Recursion:}</strong>{[10:47:55.536] 90 | Recursion is supported with }<inlineCode parentName="p">{set.recurse}</inlineCode>{ for both sync and async use cases, but is not supported in the cleanup function.}</p> [10:47:55.568] [10:47:55.568] �[0m [10:47:55.568] �[0m �[0m�[97m�[41mSyntaxError�[0m�[37m�[41m:�[0m�[37m�[41m �[0m�[97m�[41m/vercel/path0/docs/extensions/effect.mdx: Expected corresponding �[0m �[0m�[97m�[41mJSX closing tag for <details>. (87:0)�[0m [10:47:55.568] �[0m �[0m�[97m�[41m 85 | })�[0m [10:47:55.568] �[0m �[0m�[97m�[41m 86 | }�[0m[10:47:55.568] �[0m �[0m�[97m�[41m> 87 | �[0m [10:47:55.569] �[0m �[0m�[97m�[41m | ^�[0m [10:47:55.569] �[0m �[0m�[97m�[41m 88 | [10:47:55.569] �[0m �[0m�[97m�[41m 89 | { [10:47:55.569] �[0m �[0m [10:47:55.569] �[0m �[0m�[90m-�[0m �[0m�[93mcredentials.ts�[0m�[90m:�[0m�[93m62�[0m�[37m �[0m�[37minstantiate�[0m [10:47:55.569] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parse-error/credentials.ts:62:21�[0m [10:47:55.569] �[0m �[0m [10:47:55.569] �[0m �[0m�[90m-�[0m �[0m�[93mparse-error.ts�[0m�[90m:�[0m�[93m60�[0m�[37m �[0m�[37mtoParseError�[0m [10:47:55.570] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parse-error.ts:60:12�[0m [10:47:55.570] �[0m �[0m [10:47:55.570] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m1487�[0m�[37m �[0m�[37mJSXParserMixin.raise�[0m [10:47:55.570] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/tokenizer/index.ts:1487:19�[0m [10:47:55.570] �[0m �[0m [10:47:55.570] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m516�[0m�[37m �[0m�[37mJSXParserMixin.jsxParseElementAt�[0m [10:47:55.570] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:516:18�[0m [10:47:55.570] �[0m �[0m [10:47:55.570] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m469�[0m�[37m �[0m�[37mJSXParserMixin.jsxParseElementAt�[0m [10:47:55.570] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:469:34�[0m [10:47:55.570] �[0m �[0m [10:47:55.571] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m469�[0m�[37m �[0m�[37mJSXParserMixin.jsxParseElementAt�[0m [10:47:55.571] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:469:34�[0m [10:47:55.571] �[0m �[0m [10:47:55.571] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m469�[0m�[37m �[0m�[37mJSXParserMixin.jsxParseElementAt�[0m [10:47:55.571] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:469:34�[0m [10:47:55.571] �[0m �[0m [10:47:55.571] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m548�[0m�[37m �[0m�[37mJSXParserMixin.jsxParseElement�[0m [10:47:55.571] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:548:19�[0m [10:47:55.571] �[0m �[0m [10:47:55.571] �[0m �[0m�[90m-�[0m �[0m�[93mindex.ts�[0m�[90m:�[0m�[93m564�[0m�[37m �[0m�[37mJSXParserMixin.parseExprAtom�[0m [10:47:55.571] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/plugins/jsx/index.ts:564:21�[0m [10:47:55.571] �[0m �[0m [10:47:55.572] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m718�[0m�[37m �[0m�[37mJSXParserMixin.parseExprSubscripts�[0m [10:47:55.572] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:718:23�[0m [10:47:55.572] �[0m �[0m [10:47:55.572] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m695�[0m�[37m �[0m�[37mJSXParserMixin.parseUpdate�[0m [10:47:55.572] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:695:21�[0m [10:47:55.572] �[0m �[0m [10:47:55.572] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m657�[0m�[37m �[0m�[37mJSXParserMixin.parseMaybeUnary�[0m [10:47:55.572] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:657:23�[0m [10:47:55.572] �[0m �[0m [10:47:55.572] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m395�[0m�[37m �[0m�[37mJSXParserMixin.parseMaybeUnaryOrPrivate�[0m [10:47:55.572] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:395:14�[0m [10:47:55.572] �[0m �[0m [10:47:55.572] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m407�[0m�[37m �[0m�[37mJSXParserMixin.parseExprOps�[0m [10:47:55.573] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:407:23�[0m [10:47:55.573] �[0m �[0m [10:47:55.573] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m362�[0m�[37m �[0m�[37mJSXParserMixin.parseMaybeConditional�[0m [10:47:55.573] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:362:23�[0m [10:47:55.573] �[0m �[0m [10:47:55.573] �[0m �[0m�[90m-�[0m �[0m�[93mexpression.ts�[0m�[90m:�[0m�[93m302�[0m�[37m �[0m�[37mJSXParserMixin.parseMaybeAssign�[0m [10:47:55.573] �[0m �[0m �[0m�[90m[website]/[@babel]/parser/src/parser/expression.ts:302:21�[0m [10:47:55.573] �[0m �[0m [10:47:55.573] �[0m [10:47:55.573] not finished source and transform nodes - 0.469s [10:47:56.574] error Command failed with exit code 1. [10:47:56.575] info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command. [10:47:56.594] Error: Command "yarn run build" exited with 1 [10:47:57.717] |
1b28e7f
to
722c6c5
Compare
|
I fixed the Vercel deployment. I had missed a closing tag on the previous |
Summary
Add section for recurse api and clean up wording
Check List
yarn run prettierfor formatting code and docs (prettier updates unrelated files)