fixed manual to match current Sanic app name policy #2461
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It seems that Sanic has a pretty strict naming policy which doesn't allow spaces and/or comma or similar characters in the app name following is the exception raised when using the current name as appears in the manual: `sanic.exceptions.SanicException: Sanic instance named 'Hello World App' uses an invalid format. Names must begin with a character and may only contain alphanumeric characters, _, or -. `
now the name is both valid and readable
Codecov Report
@@ Coverage Diff @@
## main #2461 +/- ##
=============================================
- Coverage 87.255% 87.196% -0.060%
=============================================
Files 60 60
Lines 5061 5061
Branches 909 909
=============================================
- Hits 4416 4413 -3
- Misses 474 476 +2
- Partials 171 172 +1
Continue to review full report at Codecov.
|
ChihweiLHBird
pushed a commit
to ChihweiLHBird/sanic
that referenced
this pull request
Jun 1, 2022
Co-authored-by: Adam Hopkins <adam@amhopkins.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current app name in the manual (README) is wrong and cause an error due to Sanic app name policy
according to the error that is being raised:
"Names must begin with a character and may only contain alphanumeric characters, _, or -"
Hence, it is suggested to change the name in the example to a valid name that contains only alphanumeric chars and hyphens