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

Docs: typo in channels docs create_route_handlers -> create_ws_route_handlers #3596

Closed
byte-bot-app bot opened this issue Jun 24, 2024 · 9 comments · Fixed by #3618
Closed

Docs: typo in channels docs create_route_handlers -> create_ws_route_handlers #3596

byte-bot-app bot opened this issue Jun 24, 2024 · 9 comments · Fixed by #3618
Assignees
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on

Comments

@byte-bot-app
Copy link

byte-bot-app bot commented Jun 24, 2024

Reported by

Coffee in Discord: #general

Description

Btw, there is a small typo (https://docs.litestar.dev/latest/usage/channels.html#id9) "create_route_handlers"

MCVE

N/A

Logs

N/A

Litestar Version

Main


Note

While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@JacobCoffee JacobCoffee added Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on Good First Issue This is good for newcomers to take on labels Jun 24, 2024
@l-armstrong
Copy link
Contributor

Is this issue still open? I'm new to the project and would to take this on.

@Alc-Alc
Copy link
Contributor

Alc-Alc commented Jul 9, 2024

Is this issue still open? I'm new to the project and would to take this on.

Yes, feel free 🙂

@l-armstrong
Copy link
Contributor

Great! Also. since I do not have access to a linux machine, (I'm using a mac), am I limited to only doc contributions?

@Alc-Alc
Copy link
Contributor

Alc-Alc commented Jul 9, 2024

Great! Also. since I do not have access to a linux machine, (I'm using a mac), am I limited to only doc contributions?

I would say, if anything Windows is what that could be iffy, as long as tests run it should mostly be ok

@JacobCoffee
Copy link
Member

@l-armstrong You can use your mac to contribute anything or GitHub codespaces if you would like (https://codespaces.new/litestar-org/litestar?quickstart=1).

No blockers there :)

@l-armstrong
Copy link
Contributor

@JacobCoffee great, thank you!

@l-armstrong
Copy link
Contributor

I'm running into an error whenever I try to commit my changes.

RuntimeError: failed to find interpreter for Builtin discover of python_spec='3.8'

On the documentation to contribute it says:

The lowest currently supported version is Python 3.8. At a minimum you will need Python 3.8 for code changes and 3.12 if you plan on doing documentation building / changes.

I'm currently running Python 3.12 in Visual Studio Code which meet the requirements.

In the .pre-commit-config.yaml file, it states

default_language_version:
  python: "3.8"

Does this mean I have to specifically run 3.8? My assumption is that somewhere in the codebase, its expecting to find "3.8" locally, but I'm new to the project so this could be wrong.

@JacobCoffee
Copy link
Member

I believe Py38 just needs to be available in $PATH for it to run.
Docs changes would run in CI with 3.12, code from 3.8-3.12, and pre-commit on 3.8... so you might need both 😬

@l-armstrong
Copy link
Contributor

I created a PR for this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on Help Wanted 🆘 This is good for people to work on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants