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

Add special formatting for more moonwave doc comment tags #769

Open
AridAjd opened this issue Sep 17, 2024 · 7 comments
Open

Add special formatting for more moonwave doc comment tags #769

AridAjd opened this issue Sep 17, 2024 · 7 comments
Labels
enhancement New feature or request

Comments

@AridAjd
Copy link

AridAjd commented Sep 17, 2024

List of moonwave doc comments that do not work:

@deprecated
@unreleased
@readonly
@interface
@function
@method
@__index
@private
@ignore
@plugin
@within
@server
@yields
@client
@since
@class
@prop
@type
@tag
@JohnnyMorganz
Copy link
Owner

Some of these I did not bother with since I didn't see much value in translating them. Is there anything in particular you think would be useful if it was specially handled?

@AridAjd
Copy link
Author

AridAjd commented Sep 19, 2024

Is there anything in particular you think would be useful if it was specially handled?

I feel like the important ones would be class, since, deprecated, readonly and maybe unreleased. I don't really think of any other when using moonwave comment styles.

@hoontee
Copy link

hoontee commented Sep 19, 2024

I personally use @deprecated, @private, @ignore, and @yields.

@znotfireman
Copy link

iirc @deprecated already strikes out the valur from intellisense

@hoontee
Copy link

hoontee commented Sep 19, 2024

Nope
{C13E439A-6966-4702-8728-DA639F0EC6CF}

@JohnnyMorganz
Copy link
Owner

We handle @deprecated for autocomplete. Unfortunately it is more challenging to make it show up in diagnostics due to the way the Luau typechecking infrastructure is set up.

For the other tags, how would you like to see it being handled better? What advantage would it give compared to the current formatting? I don't mind doing it, just curious what the value is

@JohnnyMorganz JohnnyMorganz changed the title Not all moonwave doc comments are properly viewed Add special formatting for more moonwave doc comment tags Nov 10, 2024
@JohnnyMorganz JohnnyMorganz added the enhancement New feature or request label Nov 10, 2024
@AridAjd
Copy link
Author

AridAjd commented Nov 11, 2024

For the other tags, how would you like to see it being handled better? What advantage would it give compared to the current formatting? I don't mind doing it, just curious what the value is

Maybe like coloring the tags, or maybe styling them like making them bold or italic. Since the when using tags, the @ always shows up and it's not that satisfying to the eyes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants