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: bad links in flask migration docs #3587

Closed
JacobCoffee opened this issue Jun 21, 2024 · 2 comments · Fixed by #3660
Closed

Docs: bad links in flask migration docs #3587

JacobCoffee opened this issue Jun 21, 2024 · 2 comments · Fixed by #3660
Assignees
Labels
Documentation 📚 This is related to documentation Good First Issue This is good for newcomers to take on

Comments

@JacobCoffee
Copy link
Member

JacobCoffee commented Jun 21, 2024

Summary

https://docs.litestar.dev/latest/migration/flask.html

image

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 21, 2024
@l-armstrong
Copy link
Contributor

I'm looking to take on this issue. I do have a question.
Is it that the document should not have something like:Body <usage/4-request-data/#specifying-a-content-type>_?

and should instead render something of the form request.get_json, request.headers, etc. ?

@JacobCoffee
Copy link
Member Author

JacobCoffee commented Jul 10, 2024

Those links inside <...> have changed or something - So finding where they are supposed to be will just be a bit of digging. like the first one,

request.files
Use `UploadFile <usage/4-request-data/#file-uploads>`_

Should probably be pointing to https://docs.litestar.dev/2/usage/requests.html#file-uploads which would be something like UploadFile <usage/requests/file-uploads>`_ instead, and the same for the others:

request.form
request.form(), prefer `Body <usage/4-request-data/#specifying-a-content-type>`_

request.get_json
request.json(), prefer the `data keyword argument <usage/4-request-data/#request-body>`_

And they would all just be hyperlinks to their respective sections

@JacobCoffee JacobCoffee removed the Help Wanted 🆘 This is good for people to work on label Jul 10, 2024
jlr295 pushed a commit to jlr295/litestar that referenced this issue Aug 10, 2024
JacobCoffee added a commit that referenced this issue Aug 12, 2024
* fix:(ISSUE #3587) Fixed bad links in flask migration document.

* Update docs/migration/flask.rst

* Update docs/migration/flask.rst

* Update docs/migration/flask.rst

---------

Co-authored-by: Jaclyn Rutter <91439766+jaclynrutter19@users.noreply.github.com>
Co-authored-by: Jacob Coffee <jacob@z7x.org>
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
Projects
Status: Closed
Development

Successfully merging a pull request may close this issue.

2 participants