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 Docs Tool] File type detection for code documentation #379

Closed
KalleV opened this issue Oct 16, 2023 · 4 comments
Closed

[Add Docs Tool] File type detection for code documentation #379

KalleV opened this issue Oct 16, 2023 · 4 comments
Assignees
Labels
bug 🐛 Something is working solved

Comments

@KalleV
Copy link

KalleV commented Oct 16, 2023

I tried out https://github.com/Codium-ai/pr-agent/blob/d13a92515b3810d4a0fd02a060eafc26441f15d8/docs/ADD_DOCUMENTATION.md, and it works great! I did run into an issue with it applying JSDoc / JS comment syntax to SQL migration files, though.

Multi-language support would be great to add to this tool!

@mrT23
Copy link
Collaborator

mrT23 commented Oct 16, 2023

@KalleV can you share more info on what went wrong ? maybe reproduction example ?

this feature is supposed to be multi-language

@hussam789

@mrT23 mrT23 added the bug 🐛 Something is working label Oct 16, 2023
@KalleV
Copy link
Author

KalleV commented Oct 16, 2023

Sure, here's a reproduction on a SQL file: KalleV/pr-agent-tester#3

@mrT23
Copy link
Collaborator

mrT23 commented Oct 16, 2023

@KalleV thanks, @hussam789 (the feature owner 😄 ) will take a look.

Regardless, we are going to add a similar ability to the IDE extension - adding docstring to new or edited components before a PR

I think it will be even more useful there, because the most convenient place to edit\enhance your code is the IDE, not comittable suggestions in Github, which are harder to inspect and debug. So stay tuned.

@hussam789
Copy link
Collaborator

@KalleV

This feature is meant to document code components (methods, classes...etc), not scripts (SQL, Bash...etc).

I opened a PR that has a blacklist of extensions so add_doc feature is restricted only to programming languages.

@mrT23 mrT23 added the solved label Oct 21, 2023
@mrT23 mrT23 closed this as completed Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something is working solved
Projects
None yet
Development

No branches or pull requests

3 participants