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: Move .. code-block:: directives into docs/examples/ #3362

Open
JacobCoffee opened this issue Apr 10, 2024 · 0 comments
Open

Docs: Move .. code-block:: directives into docs/examples/ #3362

JacobCoffee opened this issue Apr 10, 2024 · 0 comments
Labels
Documentation 📚 This is related to documentation Help Wanted 🆘 This is good for people to work on

Comments

@JacobCoffee
Copy link
Member

JacobCoffee commented Apr 10, 2024

Description

During docs updates we have run into a few places were we have stale code because they are not tested.

For example we have some references to Pydantic in the core lib even though it was removed, Caching methods no longer available, etc.

We should move all of these out into docs/examples so that they can be tested inside of our CI to catch stale entries.

From Comment:

This is more evidence towards us needing to move any examples into examples/ and have them tested with each PR so they dont go stale.

We dont have to show the whole app, we could :linenos: it, but we should really work on that

Originally posted by @JacobCoffee in #3345 (comment)


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
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 Help Wanted 🆘 This is good for people to work on
Projects
None yet
Development

No branches or pull requests

1 participant