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.

Sign up for GitHub

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

Jump to bottom

Functions that have both type annotation and doc are not shown in the autocomplete window #72

Closed
gaku-sei opened this issue Jan 29, 2021 · 0 comments · Fixed by rescript-lang/rescript-editor-support#65
Closed

Functions that have both type annotation and doc are not shown in the autocomplete window #72

gaku-sei opened this issue Jan 29, 2021 · 0 comments · Fixed by rescript-lang/rescript-editor-support#65

Comments

@gaku-sei
Copy link

gaku-sei commented Jan 29, 2021 •
edited
Loading

Say we have an ArrayExtra module, and define a function inside like the following:

@ocaml.doc("Hello doc")
let usefulFunction: unit => int = () => 1

Typing ArrayExtra.u will show the following:

Capture d’écran 2021-01-29 à 14 02 29

If I remove the type annotation, or the doc, it works:

Capture d’écran 2021-01-29 à 14 04 12

While I'm aware the syntax for doc will change soon and not use @ocaml.doc anymore, and while I'm also aware that type annotations are optional in many cases, I thought it could be interesting to understand why the function doesn't show up 😕

Edit: My bad, it seems it works for some other functions. So when a function with type annotation + doc appears in the suggestions list, it'll always appear, but some functions don't appear for any reason, and the only to force them to appear is to drop the types for instance.
cristianoc added a commit to rescript-lang/rescript-editor-support that referenced this issue Feb 15, 2021
@cristianoc
Fix issue where values declared with type annotation would not show u…
6477b3f 
…p in autocomplete, and would show no doc comment on hover.

Fixes rescript-lang/rescript-vscode#72.

E.g.

```res
@ocaml.doc("Doc comment for functionWithTypeAnnotation")
let functionWithTypeAnnotation : unit => int = () => 1
```
@cristianoc cristianoc mentioned this issue Feb 15, 2021
Merged
cristianoc added a commit to rescript-lang/rescript-editor-support that referenced this issue Feb 15, 2021
@cristianoc
Fix issue where values declared with type annotation would not show u…
bb6f155 
…p in autocomplete, and would show no doc comment on hover.

Fixes rescript-lang/rescript-vscode#72.

E.g.

```res
@ocaml.doc("Doc comment for functionWithTypeAnnotation")
let functionWithTypeAnnotation : unit => int = () => 1
```
cristianoc added a commit that referenced this issue Mar 15, 2021
@cristianoc
Sync up with rescript-editor-support c57ed6d
b4384e2 
Sync up with rescript-lang/rescript-editor-support@c57ed6d

#### New features
- Add support for autocomplete for pipe-first `foo->`: the type of `foo` is used to determine the module to take completions from.
- Add support for autocomplete for decorators such as `@module` and `@val`.
- Add support for autocomplete of labelled arguments `foo(~label... )`.

#### Fixes

- Fix issue for uncurried functions where the internal definition of `Js.Fn.arity` is shown on hover. (See rescript-lang/rescript-editor-support#62).
- Fix type hint when hovering over labeled arguments of components (See rescript-lang/rescript-editor-support#63).
- Fix issue where values declared with type annotation would not show up in autocomplete, and would show no doc comment on hover. (See #72).
- Fix hover on definitions inside a react component module, or whenever multiple definitins for the same value exist in the module (See rescript-lang/rescript-editor-support#67).
- Fix autocomplete issue where multiple open's were considered in the wrong priority order (See rescript-lang/rescript-editor-support#72).
@cristianoc cristianoc mentioned this issue Mar 15, 2021
Merged
chenglou pushed a commit that referenced this issue Mar 15, 2021
@cristianoc
Sync up with rescript-editor-support c57ed6d (#94)
951e285 
Sync up with rescript-lang/rescript-editor-support@c57ed6d

#### New features
- Add support for autocomplete for pipe-first `foo->`: the type of `foo` is used to determine the module to take completions from.
- Add support for autocomplete for decorators such as `@module` and `@val`.
- Add support for autocomplete of labelled arguments `foo(~label... )`.

#### Fixes

- Fix issue for uncurried functions where the internal definition of `Js.Fn.arity` is shown on hover. (See rescript-lang/rescript-editor-support#62).
- Fix type hint when hovering over labeled arguments of components (See rescript-lang/rescript-editor-support#63).
- Fix issue where values declared with type annotation would not show up in autocomplete, and would show no doc comment on hover. (See #72).
- Fix hover on definitions inside a react component module, or whenever multiple definitins for the same value exist in the module (See rescript-lang/rescript-editor-support#67).
- Fix autocomplete issue where multiple open's were considered in the wrong priority order (See rescript-lang/rescript-editor-support#72).
cristianoc added a commit that referenced this issue Mar 29, 2021
@cristianoc
Sync rescript-editor-support
4977546 
Sync rescript-editor-support to commit rescript-lang/rescript-editor-support@ae455c7

Since release 1.0.5:

#### New features
- Add support for autocomplete for pipe-first `foo->`: the type of `foo` is used to determine the module to take completions from.
- Add support for autocomplete for decorators such as `@module` and `@val`.
- Add support for autocomplete of labelled arguments `foo(~label... )`.
- Add support for @deprecated attributes in autocomplete and hover.
- Support for upcoming `rescript` npm package for the compiler. Looks for `rescript` in addition to `bs-platform` in `node_modules`.

#### Fixes

- Fix issue for uncurried functions where the internal definition of `Js.Fn.arity` is shown on hover. (See rescript-lang/rescript-editor-support#62).
- Fix type hint when hovering over labeled arguments of components (See rescript-lang/rescript-editor-support#63).
- Fix issue where values declared with type annotation would not show up in autocomplete, and would show no doc comment on hover. (See #72).
- Fix hover on definitions inside a react component module, or whenever multiple definitins for the same value exist in the module (See rescript-lang/rescript-editor-support#67).
- Fix autocomplete issue where multiple open's were considered in the wrong priority order (See rescript-lang/rescript-editor-support#72).
- Autocomplete: add support for `open!` in addition to `open`.
@cristianoc cristianoc mentioned this issue Mar 29, 2021
Merged
chenglou pushed a commit that referenced this issue Mar 30, 2021
@cristianoc
Sync rescript-editor-support (#99)
446f838 
* Sync rescript-editor-support

Sync rescript-editor-support to commit rescript-lang/rescript-editor-support@ae455c7

Since release 1.0.5:

#### New features
- Add support for autocomplete for pipe-first `foo->`: the type of `foo` is used to determine the module to take completions from.
- Add support for autocomplete for decorators such as `@module` and `@val`.
- Add support for autocomplete of labelled arguments `foo(~label... )`.
- Add support for @deprecated attributes in autocomplete and hover.
- Support for upcoming `rescript` npm package for the compiler. Looks for `rescript` in addition to `bs-platform` in `node_modules`.

#### Fixes

- Fix issue for uncurried functions where the internal definition of `Js.Fn.arity` is shown on hover. (See rescript-lang/rescript-editor-support#62).
- Fix type hint when hovering over labeled arguments of components (See rescript-lang/rescript-editor-support#63).
- Fix issue where values declared with type annotation would not show up in autocomplete, and would show no doc comment on hover. (See #72).
- Fix hover on definitions inside a react component module, or whenever multiple definitins for the same value exist in the module (See rescript-lang/rescript-editor-support#67).
- Fix autocomplete issue where multiple open's were considered in the wrong priority order (See rescript-lang/rescript-editor-support#72).
- Autocomplete: add support for `open!` in addition to `open`.

* Don't show deprecated message on hover.

Sync up with rescript-lang/rescript-editor-support@03ee0d9
chenglou pushed a commit to chenglou/rescript-editor-support that referenced this issue Apr 24, 2021
@cristianoc @chenglou
Fix issue where values declared with type annotation would not show u…
53986cb 
…p in autocomplete, and would show no doc comment on hover.

Fixes rescript-lang/rescript-vscode#72.

E.g.

```res
@ocaml.doc("Doc comment for functionWithTypeAnnotation")
let functionWithTypeAnnotation : unit => int = () => 1
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@gaku-sei