Skip to content
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

docs: Populate Component Instance #304

Closed
angelogulina opened this issue Oct 18, 2020 · 5 comments · Fixed by #466
Closed

docs: Populate Component Instance #304

angelogulina opened this issue Oct 18, 2020 · 5 comments · Fixed by #466
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@angelogulina
Copy link
Contributor

Following up on this and this, I'm opening the Issue to help trace work and discussion about the Component Instance section.

@angelogulina
Copy link
Contributor Author

Hi @afontcu, I'd like to start on this so asking for some guidance.

My idea for the initial approach would be to have these 3 sub items of Component Instance:

  • port findComponent from V1 docs considering differences
  • port props from V1 docs, considering differences

something like this:

Screenshot 2020-10-18 at 11 31 38

Then 2 questions:

  1. as far as I understand, the .vm part could be contained in the findComponent section?
  2. anything else that would be nice to have (also fine to do it in a next Issue / PR)

Thanks!

@afontcu
Copy link
Member

afontcu commented Oct 19, 2020

Hi!

Bear in mind that in VTU-next docs we're tying to focus on how to test stuff, instead of writing an API-centered documentation. This wasn't the case with VTU docs.

With that in mind, I would try to think of a use case were findComponent and props (and possibly .vm?) would make sense, and use the use case as a drive to showcase their use.

Does it sound OK to you? Any ideas?

btw:

Also why .vm is not available

AFAIK is no longer true :)

and yet another recommendation to test outputs instead of implementation details

this is still true 😉

@angelogulina
Copy link
Contributor Author

Thanks for the guidance.

Sounds OK, sure. Don't have an idea on top of my head but I will find plenty I guess from the codebase I work on 😂

As soon as I have something, I'll push a draft and we can continue the discussion there.

@afontcu
Copy link
Member

afontcu commented Jan 16, 2021

Hi @angelogulina! Just stopping by to see if you had something about this 😄

Cheers!

@angelogulina
Copy link
Contributor Author

Hi @afontcu thanks for the ping. Still plan to write this one, yes but been really busy.

I'd tackle it around beginning of FEB if that works for you.

@afontcu afontcu transferred this issue from vuejs/test-utils-docs Jan 25, 2021
@afontcu afontcu added the documentation Improvements or additions to documentation label Jan 25, 2021
@afontcu afontcu changed the title Populate in depth section Component Instance docs: Populate Component Instance Jan 25, 2021
@lmiller1990 lmiller1990 self-assigned this Mar 16, 2021
lmiller1990 added a commit that referenced this issue Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants