dotnet / dotnet/api-docs-sync

PortToDocs changing many docs which aren't touched by intellisense input

Ouverte
#179 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
C#
Étoiles
14
Forks
21
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

It seems to be trying to copy the docs from the interface and/or inheritdoc target.

It shouldn't do this, since it duplicates the doc content. If a member has inheritdoc already the docs build will automatically copy the docs. If a member implements an interface then we can add inheritdoc to opt-in to this.

Guide de contribution

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

Piste de recherche

Commencez par localiser le point d’entrée PortToDocs et reproduisez le cas où la documentation de interface ou inheritdoc est copiée alors qu’elle ne figure pas dans l’entrée IntelliSense. Suivez les membres sélectionnés pour les modifications et vérifiez que le comportement inheritdoc existant reste délégué à la build de docs. C’est terminé lorsque les membres non concernés ne sont plus modifiés et que les implémentations d’interface ne changent que lorsque inheritdoc est explicitement ajouté.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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