[api-documenter] namespace and interface with same name documents only the namespace
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 42/100
- Type d'issue
- Bug
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- typescript
- Domaine
- documentation, tooling
Piste de recherche
Reproduce the collision with the two npx commands, using npm/api-extractor.json as the input configuration and tmp and docs/js as the output locations. Inspect how @microsoft/api-documenter markdown names and writes pages for the namespace and interface. Done means both declarations have distinct Markdown pages and links resolve to the correct documentation.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Summary
I have an interface named mynamespace.Persistence and also a namespace with more classes mynamespace.persistence.Stuff the markdown files written in markdown mode all have lowercase names so these end up with the same name and I only end up with a file documenting the namespace not the interface. I get a link to what should be the interface documentation, but it's the same page as the namespace, having been (it seems) overwritten.
Repro steps
Have a namespace and interface with same names (different case).
npx @microsoft/api-extractor run -c npm/api-extractor.json
npx @microsoft/api-documenter markdown -i tmp -o docs/js/
Standard questions
Please answer these questions to help us investigate your issue more quickly:
| Question | Answer |
|---|---|
| Operating system? | Linux |
| Documentation target? | Markdown |
| Would you consider contributing a PR? | Yes |
- Langage dominant
- TypeScript
- Étoiles
- 6.5k
- Forks
- 708
- Merge moyen
- 4 j 13 h
- PR mergées (30 j)
- 62
Préparer son environnement
Nous n'avons pas encore vérifié les fichiers d'installation de ce projet. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de microsoft/rushstack
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
microsoft/rushstack#5971 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
microsoft/rushstack#5902 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
microsoft/rushstack#5839 · 1 réaction ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
microsoft/rushstack#5683 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de microsoft/rushstack
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
diegosouzapw/OmniRoute#14869 ·
Les mainteneurs répondent en général sous 1 jour
-
enhancement
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 94/100
Les mainteneurs répondent en général sous 1 jour
-
status: waiting triage
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
freeCodeCamp/freeCodeCamp#70412 ·
Les mainteneurs répondent en général sous 1 jour
-
Mend: dependency security vulnerability untriaged
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
opensearch-project/OpenSearch-Dashboards#12816 ·
Les mainteneurs répondent en général sous 1 jour