UML class diagram of 'exception' is not rendered correctly on the deployed documentation

Ouverte
#3 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
8/100
Type d'issue
Bug
Clarté
À clarifier
Activité
À l'abandon
Domaine
documentation

Piste de recherche

The broken UML class diagram appears on two documentation pages, /home/exceptions/ and /api/basic_json/exception/, and the reporter says a local render is fine, so the fault is probably in how the docs are generated. This repository only holds the release scripts, so the generator is likely in the main nlohmann/json repository. Compare the generated page source against a local render to find where the diagram breaks. Done means the diagram renders on both deployed pages.

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

Description

The UML class diagram shown on the following pages seems not rendered correctly:

A local render of the UML code seems ok, so I suspect something went wrong during the documentation generation. This is why I'm reporting this here rather then on the main repository.

Current display:
image
image

Local render:
image

Langage dominant
Python
Étoiles
6
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

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.

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.