RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.github.com/en/copilot/tutorials/copilot-chat-cookbook/document-code/sync-documentation below:

Syncing documentation with code changes

Copilot Chat can help with keeping code documentation up-to-date.

It can be difficult to keep documentation up to date with changes to code. However, good documentation is essential for maintaining codebases and ensuring that developers can work effectively with the code. Copilot Chat can assist in updating existing code documentation.

Example scenario

Imagine a scenario where you have a TypeScript function that retrieves products by category name, but the documentation is out of date.


async getByCategoryName(categoryId: number, page = 1, pageSize = 10): Promise<Products[]> {
  return await prisma.products.findMany({
    where: { categoryId },
    skip: (page - 1) * pageSize,
    take: pageSize,
    include: {
      reviews: {
        orderBy: { date: 'desc' },
        take: 5,
      },
    },
  });
}

Example prompt

You can ask Copilot Chat to update the documentation according to the current code.

Update the existing documentation for the getByCategoryName function to reflect the current implementation.

Example response

Note

The following response is an example. Copilot Chat responses are non-deterministic, so you may get a different response from the one shown here.

Copilot explains it will create the updated documentation for the getByCategoryName function. It then provides the updated documentation, which now includes the page and pageSize parameters, as well as the PrismaClientKnownRequestError error that can be thrown.

For example: