Skip to content

VNode is used in the Guide before it is defined #1799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cxw42 opened this issue Sep 16, 2018 · 6 comments
Closed

VNode is used in the Guide before it is defined #1799

cxw42 opened this issue Sep 16, 2018 · 6 comments

Comments

@cxw42
Copy link
Contributor

cxw42 commented Sep 16, 2018

Brand-new to Vue, and I'm reading the Guide front to back. The term VNode is used in the Custom Directives page. However, it is not defined until later in the Guide, in the Render Functions & JSX page. I see that was mentioned in #319 (comment).

Would someone who actually knows Vue :) be willing to update the Guide so that VNode is not used without explanation on the Custom Directives page? I don't claim to know what would be the best way to accomplish that :) . Thank you!

@phanan
Copy link
Member

phanan commented Sep 18, 2018

Would a link e.g. VNode suffice?

@cxw42
Copy link
Contributor Author

cxw42 commented Sep 18, 2018

It would certainly be better than nothing :) . Again, as a rank newbie, I think I would benefit from both the link and a brief intro at the top of the section. How about something like the below? (I'm happy to submit a PR if you wish.)

Hooks

A directive definition object can provide several hook functions (all optional). The hooks fall at various points along the path from a template or render function, through Virtual DOM nodes ("VNodes"), to real DOM nodes that are presented in the browser. We'll cover VNodes in more detail later, when we discuss render functions. For now, all you need to know is that Vue processes the Virtual DOM, then updates the real DOM based on the Virtual DOM.

  • bind...

@phanan
Copy link
Member

phanan commented Sep 18, 2018

I would actually prefer a p.tip after the update hook (where we first mention the term), which may simply say

We'll cover VNodes in more details later, when we discuss [render functions](link).

@cxw42
Copy link
Contributor Author

cxw42 commented Sep 18, 2018

You're the expert, so I defer to your judgment. Thanks!

@cxw42
Copy link
Contributor Author

cxw42 commented Dec 3, 2018

@phanan Have you had a chance to look at #1855? I just rebased it onto the latest master. Thanks!

phanan pushed a commit that referenced this issue Dec 3, 2018
Otherwise, VNode is used without definition the first time you encounter
it in the Guide.

Fixes #1799.
@phanan
Copy link
Member

phanan commented Dec 3, 2018

@cxw42 Indeed, this slips my watch :) Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants