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

Missing docs for types.lazy #2156

Open
2 of 3 tasks
coolsoftwaretyler opened this issue Feb 26, 2024 · 4 comments
Open
2 of 3 tasks

Missing docs for types.lazy #2156

coolsoftwaretyler opened this issue Feb 26, 2024 · 4 comments
Labels
docs or examples Documentation or examples related

Comments

@coolsoftwaretyler
Copy link
Collaborator

Bug report

  • I've checked documentation and searched for existing issues and discussions
  • I've made sure my project is based on the latest MST version
  • Fork this code sandbox or another minimal reproduction.

Describe the expected behavior

We should have documentation for types.lazy, introduced in #1722, but we neglected to enforce that.

Describe the observed behavior

There is no documentation. We'll reach out to the original author to see if they want to add it. If we don't hear back soon, someone on core team will handle it or find a volunteer to do so.

@coolsoftwaretyler
Copy link
Collaborator Author

Hey @clgeoio - it's probably been a while since you heard from us at MobX-State-Tree, but we realized that your types.lazy (which is awesome by the way) never got documented.

Do you have any interest in writing those docs for us? Let me know either way, thank you!

@coolsoftwaretyler coolsoftwaretyler added the docs or examples Documentation or examples related label Feb 26, 2024
@jamonholmgren
Copy link
Collaborator

jamonholmgren commented Feb 26, 2024

There is this: https://github.com/mobxjs/mobx-state-tree/blob/master/docs/API/index.md#lazy

I can't seem to find it on the website, though. Maybe just needs to be deployed?

Also needs a usage example.

@tt-nghia
Copy link

Bump this!

@coolsoftwaretyler
Copy link
Collaborator Author

Thanks @tt-nghia - will consider moving more quickly on this, although it should be a great first contribution if you wanted to pitch in and submit a PR.

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

No branches or pull requests

3 participants