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

CLI - add support for doc link in description #2042

Closed
baywet opened this issue Dec 7, 2022 · 4 comments · Fixed by #2251
Closed

CLI - add support for doc link in description #2042

baywet opened this issue Dec 7, 2022 · 4 comments · Fixed by #2251
Assignees
Labels
CLI Work to support generating CLIs with Kiota enhancement New feature or request WIP
Milestone

Comments

@baywet
Copy link
Member

baywet commented Dec 7, 2022

more details #2036 #2037. Link to the documentation was added to the code dom. The doc comment generation should be updated to include a link to the documentation for classes and methods

@baywet baywet added CLI Work to support generating CLIs with Kiota enhancement New feature or request labels Dec 7, 2022
@baywet baywet added this to the Kiota post-GA milestone Dec 7, 2022
@calebkiage
Copy link
Contributor

How should that present in the CLI? Also, because of package size, is it a good idea to split docs up into a different assembly that can be loaded when needed?

@baywet
Copy link
Member Author

baywet commented Dec 8, 2022

Kiota doesn't have an ability to split generation outcome to multiple assemblies today and it's not in the plans.
I'd be really curious to see "how big an impact" is a set of additional string constants for the help on the CLI size.
As per the doc comments, the CLI is already getting them for free from CSharp generation, but as we're building a console application I believe those are trimmed on a release build.

@darrelmiller
Copy link
Member

@calebkiage I don't believe having the link strings embedded in the binary is going to be a problem. We just need to display the link in the help output. Do you have any issues with that?

@calebkiage
Copy link
Contributor

Hey @darrelmiller, I don't have any objections to it. We can explore package size issues when they become a serious problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLI Work to support generating CLIs with Kiota enhancement New feature or request WIP
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants