search

ycm-core / ycmd

A code-completion & code-comprehension server
https://ycm-core.github.io/ycmd/
GNU General Public License v3.0
1.69k stars 765 forks source link

TS: add @param and @returns to docs #1676

Closed notEvil closed 1 year ago

notEvil commented 1 year ago

see https://github.com/ycm-core/ycmd/issues/1675

This adds a table between the signature and the description, listing all @param tags and any @return/@returns tag. If a return tag exists, it is the last row and is named return.

GetDoc: Screenshot from 2023-01-12 16-51-09 Autocomplete: Screenshot from 2023-01-12 16-52-29

Missing:

I would appreciate if anyone could write tests for this because I have 0 knowledge.

This change is Reviewable

puremourning commented 1 year ago

I doubt anyone is going to write tests for you.

puremourning commented 1 year ago

either way the existing tests are failing (flake8 errors)

notEvil commented 1 year ago

I doubt anyone is going to write tests for you.

xD nobody has to write tests for me, and I don't care enough to invest hours for practically no reward (on my side). Chances are I'd waste not only my time but others as well if I'd try.

puremourning commented 1 year ago

I don't care enough to invest hours

I guess I don't care enough to review and merge this change then.

Thanks for the contribution though. Perhaps someone who does care about this change will pick it up in the future.

notEvil commented 1 year ago

Sry, didn't see flake8-ycm coming... I won't try again

Thanks, I hope so too