DiamondLightSource / DiamondLightSource/pythonSoftIOC
Inherited methods/properties from EpicsDBBuilder are not documented
Ouverte
enhancement
- Langage dominant
- Python
- Étoiles
- 46
- Forks
- 15
- Merge moyen
- 1 j 18 h
- PR mergées (30 j)
- 1
Description
There's currently no documentation that says what is (and is not) inherited from EpicsDBBuilder and so what is valid to call on a `RecordWrapper` instance. This should be improved.
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par localiser EpicsDBBuilder et RecordWrapper dans les sources Python et examinez leur relation d’héritage. Documentez les méthodes et propriétés héritées qui sont valides sur les instances de RecordWrapper, afin que la documentation terminée explicite clairement cette limite.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 42/100