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

Document how MST lazily creates objects #2058

Open
scytacki opened this issue Aug 7, 2023 · 1 comment
Open

Document how MST lazily creates objects #2058

scytacki opened this issue Aug 7, 2023 · 1 comment
Assignees
Labels
docs or examples Documentation or examples related

Comments

@scytacki
Copy link
Contributor

scytacki commented Aug 7, 2023

I think it would be useful to document how MST lazily creates its objects. It is that delay that caused #1951, and that delay is why it is possible with #1952 for the hooks to be called in different orders depending on how the objects are being referenced.

It is kind of a implementation detail (but a big one), so maybe you don't want it in the user facing documentation.

If I can find time I'll try make a PR adding documentation for this, but @coolsoftwaretyler and @jamonholmgren do you have opinions about where this documentation should go? It could be in hooks.md but it is kind of more general than that. It could be a new doc in "concepts". Or maybe you'd like to keep it just for developers; in that case I'm not sure where it should go.

@coolsoftwaretyler
Copy link
Collaborator

Hey @scytacki - thanks for this! I personally would love to have it in the user-facing docs.

I think it might fit OK in Advanced Concepts, but I also think there isn't a great place for it as things stand.

One of the things we'll be doing to revitalize things around here is a docs overhaul. So if you were to write this up and drop it wherever, I think we can use that as an input for how we structure new docs.

There is no firm plan on where, when, how, etc. of the new docs, but I expect we'll get to it within the calendar year, or just into 2024.

I'm going to add some labels and assign this issue to you for the sake of keeping things tidy in the issue tracker. If you ever decide you don't want to do this, remove yourself and we can find another contributor to do so.

@coolsoftwaretyler coolsoftwaretyler added the docs or examples Documentation or examples related label Aug 9, 2023
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

2 participants