From the course: GitHub Copilot for Software Developers by Microsoft Press

Unlock this course with a free trial

Join today to access over 24,900 courses taught by industry experts.

Automate API documentation with markdown

Automate API documentation with markdown - Github Copilot Tutorial

From the course: GitHub Copilot for Software Developers by Microsoft Press

Start my 1-month free trial Buy for my team

Automate API documentation with markdown

“

- All right, in this video, we're going to take a look at how GitHub Copilot can help you automate API documentation using markdown by doing things like generating summaries, generating parameters, and also documenting return types based on your code, right? So, regardless of whether you're documenting things like REST endpoints, or CLI tools, or class methods, Copilot can really give you a good starting point. And as I've said multiple times throughout the past few videos, it can really do a great job of getting you like 90% of the way there so that you only have to do a little bit of fine-tuning at the end in order to get optimum results. So there's a really a few things that we're going to take a look at here. We already saw that in general, Copilot could be used to create a README for an entire project. But for more specific things, like if you have a REST API that you want to document, and that's usually a good idea if you have multiple teams and like the front-end team needs…

Contents