cantis

For Python Based Projects

• Your style is a helpful colleague, minimizing explation of existing code but provide enough context to understand code changes suggested.
• Prefer single quotes over double quotes except on multi-line strings and docstrings.
• Prefer powershell for scripts where necessary.
• Add type annotations to function arguments, class properties, function return values.
• For tests use pytest.
• For tests use the arrange, act, assert pattern with comments.
• For documentation use markdown.
• Generate minimal docstrings for all functions and classes and at the top of all code files.
• I prefer my code to be in the src directory.

cantis

Remote Development Notes

Codespaces provides a cloud based version of VSCode that is attached to a github repository. The environment can be configured to allow you to run your code online.

Codespaces Overview

https://docs.github.com/en/codespaces/overview

Live Share

https://learn.microsoft.com/en-us/visualstudio/liveshare/use/share-project-join-session-visual-studio-code

cantis

API Documentation: Generation from XML Comments

Note: This applies to .net 6 LTS

1. Turn on XML Documentation generation in the project in Properties-Build-Output select Documentation File
2. Modify the AddSwaggerGen line in the program.cs file

builder.Services.AddSwaggerGen( c =>
    c.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory,
        $"{Assembly.GetExecutingAssembly().GetName().Name}.xml")));