docs: Optimized readme.md code format #1681
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 cf4fdb5:
|
|
The partial code is intentional to reduce the lines of readme. Does it seem too confusing? btw, I didn't know prettier didn't work for readme.md. |
readme.md
Outdated
|
|
||
| function Status() { | ||
| // Re-renders the component after urlAtom changed and the async function above concludes | ||
| const [json] = useAtom(fetchUrlAtom) | ||
| } |
There was a problem hiding this comment.
You're right ~，Can I replace it with this ?
function Status() {
// Re-renders the component after urlAtom changed and the async function above concludes
const [json] = useAtom(fetchUrlAtom);
useEffect(()=>{
// Logical processing base on json
console.log(json)
},[json])
return <div>Content</div>;
}There was a problem hiding this comment.
That seems over-complicated. We want to keep readme very compact, and move detailed things into ./docs/.
There was a problem hiding this comment.
Got it , thanks .
The partial code looks a little uncomfortable， Maybe it's just my personal habit ～ 😂 |
I heard similar comments in zustand, so you are not alone, though. |
readme.md
Outdated
| <button onClick={() => setCount((c) => c + 1)}>one up</button> | ||
| </h1> | ||
| ) | ||
| } |
There was a problem hiding this comment.
| <button onClick={() => setCount((c) => c + 1)}>one up</button> | |
| </h1> | |
| ) | |
| } | |
| <button onClick={() => setCount((c) => c + 1)}>one up</button> | |
| ... |
How about adding ... to make it explicit that it's partial code?
There was a problem hiding this comment.
good idea~ ， It works
There was a problem hiding this comment.
Shall I modify it and commit merge request again?
There was a problem hiding this comment.
Yeah, please modify entirely with the said policy.
There was a problem hiding this comment.
It's done, but some places } seem more suitable， use } instead of ....
|
#1681 (comment) |
Got it! like this ? |
43a6846
to
cf4fdb5
Compare
|
Unfortunately, we need to revert this too: |
😂 I resubmitted a copy of the code，is it ok? |
|
Should be good. Thanks! |
Thank you for your guidance ~ |
Summary
Optimized readme.md code format
Check List
yarn run prettierfor formatting code and docs