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.

Sign up for GitHub

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

Jump to bottom

--reload feature needs docs #321

Closed
LauraLangdon opened this issue Oct 31, 2023 · 3 comments · Fixed by #322
Closed

--reload feature needs docs #321

LauraLangdon opened this issue Oct 31, 2023 · 3 comments · Fixed by #322
Assignees
@kjaymiller @tataraba @LauraLangdon
Labels
documentation

Comments

@LauraLangdon
Copy link
Contributor

The new --reload feature hasn't yet been documented.
@kjaymiller
Copy link
Collaborator

going to cc: @tataraba on this. I think it would be good to chat about the best way to document this.

My suggestions are:

  • Be sure to add an admonition about this being in beta
  • Usage
  • What will trigger a reload
  • What WON'T trigger a reload (__* files, and changes that importlib won't be able to pick up.)

@kjaymiller kjaymiller mentioned this issue Nov 2, 2023
Merged
5 tasks
@kjaymiller
Copy link
Collaborator

@all-contributors please add @LauraLangdon for Documentation

@allcontributors allcontributors bot mentioned this issue Nov 21, 2023
Merged
@allcontributors AllContributors
Copy link
Contributor

@kjaymiller

I've put up a pull request to add @LauraLangdon! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kjaymiller kjaymiller

@tataraba tataraba

@LauraLangdon LauraLangdon

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

adds docs for serve render-engine/render-engine
3 participants
@kjaymiller @tataraba @LauraLangdon