question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[Core] Fix usage of @internal and @hidden tags

See original GitHub issue

Please follow the following guidelines:

  • use the @internal tag only for definitions that are not exported by src/index.ts and you do not want to generate documentation for them on docs.microsoft.com
  • use the @hidden tag only for definitions that are exported by src\index.ts but you still do not want to generate documentation for them on docs.microsoft.com
  • do not use both @internal and @hidden for one definition

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

2reactions
xirzeccommented, Feb 26, 2021

I’m leaning toward “leave those things hidden unless we have a good reason” since they’re all stuff that we’d not want external devs to see/think about

0reactions
ramya-rao-acommented, Mar 1, 2021

Thanks all!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Cache tags | Cache API | Drupal Wiki guide on Drupal.org
Comprehensive use of cache tags across Drupal allows Drupal to ship with its Internal Page Cache enabled by default. This is nothing more...
Read more >
Tag Pages & Content Tagging For SEO: A Complete Guide
Tagging can benefit SEO, personalization, and UX when done correctly. Avoid the pitfalls with this complete guide to tagging SEO.
Read more >
Practical uses for the "internal" keyword in C# - ...
A common use of internal access is in component-based development because it enables a group of components to cooperate in a private manner...
Read more >
How to hide property from displaying in Swagger? #1230
I am using .NET Core 2.2. [DataContract] ends up showing all members anyway; marking attribute as 'internal' or [JsonIgnore] doesn't deserialize ...
Read more >
Git - git-tag Documentation
The latter are usually not interested in the detailed tags used internally in the former group (that is what "internal" means). That is...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found