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.

Annotate all internal functions with '@internal'

See original GitHub issue

Even though some functions are expored from src/**/*.js files they are private. The only function exported by src/index.js and src/*/index.js are considered to be part of the public API. Please see: https://github.com/graphql/graphql-js/blob/master/src/README.md

It would be great to have all private API marked as such, e.g.: https://github.com/graphql/graphql-js/blob/6f341a3ae0d6b3cc4d9136a58fd9272c615c2dba/tstypes/validation/validate.d.ts#L32-L33

Also, it would be great to find all public APIs without JS doc comments.

Issue Analytics

  • State:open
  • Created 4 years ago
  • Reactions:1
  • Comments:8 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
IvanGoncharovcommented, Oct 1, 2019

@craicoverflow Thanks a lot for #2205 I merged it in but I will keep this issue open to tracking the development of ESLint rule. Another great subtask would be to check that all public functions have doc comments.

0reactions
nveenjaincommented, Mar 9, 2020

I created a babel-plugin for the same since we are using only ExportNamedDeclarations, this plugin only extracts the list of exported variables with ExportNamedDeclarations… This means that code like

 export let name1, name2=5, nameN;

is not supported, and name1, name2, nameN will not be output of the plugin… However this can be modified if required… You can check the plugin live at:- https://astexplorer.net/#/gist/01dc219b927b6a72efc1ca00a92fa0be/35b47cf3831059793f993bbd3a4d71b140759972

You can check the console to get the array of exported names/functions…

Read more comments on GitHub >

github_iconTop Results From Across the Web

Annotating internal function argument and return types
Hi,. Lack of type information for internal functions in Reflection is a long-standing issue. In PHP 8 we finally have all the necessary...
Read more >
Annotate Functions - SAS OnlineDoc, V8
Annotate functions act in conjunction with the other Annotate variables that determine where and how to perform the action. Many of these variables...
Read more >
typing — Support for type hints — Python 3.11.1 documentation
Introducing syntax for annotating variables outside of function ... Internally, the latter is converted to the former, so the following are equivalent:.
Read more >
Supported Annotations - Documentation - Psalm
@internal used to mark classes, functions and properties that are internal to an application or library. Off-label usage of the @var tag. The...
Read more >
Annotations in Java - GeeksforGeeks
These are the annotations that can be applied to a single item more than once. For an annotation to be repeatable it must...
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