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

[GH-1868] Updated documentation to note what auto-reload is disabled when serve() used directly. #1955

Closed
wants to merge 4 commits into from

Conversation

slyapustin
Copy link

@slyapustin slyapustin commented Apr 26, 2023

Summary

Updated documentation as suggested by @Kludex on the issue: #1868 (comment)

Checklist

  • I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
  • I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
  • I've updated the documentation accordingly.

Copy link
Member

@Kludex Kludex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be useful to add on the documentation the way to programmatically use the reload, instead of saying just that is not possible.

docs/index.md Outdated Show resolved Hide resolved
Co-authored-by: Marcelo Trylesinski <[email protected]>
sonn-gamm added a commit to hackersanddesigners/www-v2 that referenced this pull request Aug 22, 2023
at first i added an option to run the local server via the CLI, but
enabling the `reload` flag seemed undocumented (though possible?).

see <encode/uvicorn#1955>.

therefore, i made a shell script helper function.
@martinky24
Copy link

martinky24 commented Sep 25, 2023

We ran into this issue as well (hot reload not working when using server.run())-- I was about to open a PR, glad to see it already exists.

@slyapustin Would it be reasonable to also note that server.run (here) also does not enable hot reloading? I am happy to throw in a commit to note this explicit addition.

@slyapustin
Copy link
Author

I am happy to throw in a commit to note this explicit addition.
@martinky24 That would be great

@martinky24
Copy link

Ah, I realize I don't have permissions to update the branch directly I think...

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
slyapustin and others added 2 commits September 29, 2023 09:45
Co-authored-by: Kyle Martin <[email protected]>
Co-authored-by: Kyle Martin <[email protected]>
@slyapustin
Copy link
Author

Thanks @martinky24, I updated my PR with your suggestions.

@slyapustin slyapustin closed this by deleting the head repository Oct 30, 2023
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

Successfully merging this pull request may close these issues.

3 participants