Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api-documenter] Generating with "yaml" option includes Sharepoint reference #2452

Open
NickHeiner opened this issue Jan 26, 2021 · 1 comment

Comments

@NickHeiner
Copy link

Summary

When I run api-documenter yaml, I get the following output in toc.yml:

items:
  - name: SharePoint Framework reference
    href: ~/overview/sharepoint.md
    items:
      - name: jscodemod
        uid: '@nth/jscodemod!'

This appears to come from this code snippet.

I think this is just a mistake where default filler text is being included; I'm not doing anything with Sharepoint. 😄

Repro steps

I'm pretty sure this will repro anywhere, but I'm specifically seeing it at this commit in this repo. Just run yarn && yarn build-api-docs.

Details

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-documenter version? 7.12.6
Operating system? Mac
Documentation target? YAML
Would you consider contributing a PR? Sorry, I don't have time.
TypeScript compiler version? Whatever version of TS @microsoft/[email protected] uses 😄
Node.js version (node -v)? 12.14.0
@NickHeiner
Copy link
Author

Or maybe this is intentional behavior? Related: #1229.

@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Feb 26, 2024
@iclanton iclanton moved this from Needs triage to AE/AD in Bug Triage Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: AE/AD
Development

No branches or pull requests

1 participant