-
Notifications
You must be signed in to change notification settings - Fork 47
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
feat: comment complete for tidy style doc comment #1029
Conversation
For now this pull request just complete a doc string as comment complete, it is not considering the known type of the parameters, while from my perspective works better when this feature is implemented as a docstring updater or a code action. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall it looks pretty nice. We are starting to be on the rails~
I start to experience it and have found several points. We might start to complete a "Document function" only if the comment is a "doc comment" and only contains nothing. |
I have stricted the condition. Tbh, why doc comment does not utilize block comment but line comment, it's really annoying.
If I know correctly, doc a variable has no specific format right? Do we really need to complete anything for it? |
Caused that we borrow the format from rust.
You might know it wrongly. You can document any let binding items. /// A swap operation.
///
/// - a (B): It was b.
/// - b (A): It was a.
/// -> (B, A)
#let (a, b) = (b, a);
/// A simpler example.
///
/// -> content
#let embedded-file = context metadata(query(<output>)); |
Oh I didn't know this |
for #1015