Add an 'Examples' page to the docs with fully functioning example applications

Ouverte
#644 5 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
django, javascript, python
Domaine
documentation

Piste de recherche

Commencez par examiner les commentaires de l’issue liée concernant le Django CSRF-removing parser et l’Axios query-string parser, puis consultez la documentation existante de webargs et le guide de mise à niveau pour trouver d’autres candidats. Définissez la structure de la Examples page et sélectionnez un ensemble ciblé d’applications entièrement fonctionnelles. Le travail est considéré comme terminé lorsque la page et les exemples exécutables couvrent les cas convenus sans alourdir la documentation principale.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

docs

There are a few cases of interesting usages that come up in issues, but which don't seem appropriate to put into our main docs (b/c we don't want to bloat our docs). If we had an Examples page in the docs, we could show off all of our cool ideas for how you can solve problems with webargs, but without disrupting the flow of the main documentation.

Specific cases which would be good candidates for example apps:

I did a quick scan of closed issues until I hit the 5.x/6.0 transition point, then called it a day. Maybe there are other interesting examples in older issues? Or maybe we have things in other parts of the docs like the upgrade guide which would be nice to separate out (or even just duplicate).

Langage dominant
Python
Étoiles
1.4k
Forks
171
Merge moyen
8 h 47 min
PR mergées (30 j)
12

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de marshmallow-code/webargs

Toutes les issues de marshmallow-code/webargs

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.