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

class field: description not being detected on 3.x.x #1125

Closed
Bilal2453 opened this issue May 8, 2022 · 0 comments
Closed

class field: description not being detected on 3.x.x #1125

Bilal2453 opened this issue May 8, 2022 · 0 comments
Labels
bug Something isn't working

Comments

@Bilal2453
Copy link
Contributor

Describe the bug
According to question #928 you would be able to add a description to a class field by using the format:

---@class X
---cool description
---@field foo type

Although, in recent versions (specifically on latest 3.2.2), this straight up does not work.

To Reproduce
Steps to reproduce the behavior:

  1. Type the following:
---@class Apple
---The color of your awesome apple!
---@field color string
local Apple = {}
  1. Now make a new line, and type print(Apple.color.
  2. You should see the description in the drop-menu, although that does not happen. (the drop menu does show, just without the description)

Expected behavior
A description showing off in the drop-menu, or when pressing ctrl + space for completion.

Screenshots

  • A screenshot of it not working:
    image

Environment (please complete the following information):

  • OS: Linux, Fedora 35
  • Is WSL remote? No
  • Client: VSCode

Additional context
#928

Provide logs
None relevant.

@sumneko sumneko added the bug Something isn't working label May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants