Documentation outdated for `printline()`

Ouverte Adaptée aux débutants
#32 4 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
65/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Calme
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par examiner le commit 4251e7957e22f4596c95cfd1adadcd92e79ac4b et la documentation de SE3 décrivant printline(file=None). Vérifiez comment la documentation de strline() est générée ou construite, mettez à jour les indications obsolètes concernant printline et assurez-vous que strline() est documenté, puis reconstruisez la documentation ou examinez la documentation obtenue.

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

Description

enhancement

Commit 4251e7957e22f4596c95cfd1adadcd92e79ac4b8 seems to have added the strline() function for getting string representations as a replacement for printline(file=None).

Documentation for SE3 still suggests printline() will output a string when supplied with file=None:

printline

Documentation for the new strline() function also doesn't seem to have been built.

Langage dominant
Python
Étoiles
641
Forks
102
Merge moyen
1 j 18 h
PR mergées (30 j)
4

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

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 rai-opensource/spatialmath-python

Toutes les issues de rai-opensource/spatialmath-python

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.