best-practice-and-impact / assumptions Goto Github PK
View Code? Open in Web Editor NEWGenerate assumptions and caveats logs from code comments.
Home Page: https://assumptions.readthedocs.io/
License: MIT License
Generate assumptions and caveats logs from code comments.
Home Page: https://assumptions.readthedocs.io/
License: MIT License
See existing action for todo lists: https://github.com/marketplace/actions/todo-to-issue
Following our chat - aim to create a document regarding assumptions guidance.
Section 1: Background of Assumptions
Section 2: Best Practice of Assumptions
Section 3: Further Considerations
Indicate when guidance has not been followed and point to reference material
It's good practice to provide a reference for justifying an assumption, so we should support this as it's own section within an assumption item.
Document the docs conf.py
hook used in the package docs to generate output logs as part of a sphinx
build.
Either release a compiled Python binary (e.g. using cython
) or rewrite in Rust and release a compiled binary.
This will remove the dependency on Python. Trade-off is that getting the binary installed may be more difficult in many Gov departments.
As a reviewer, I need to be able to locate assumptions in source files, so that I can review the code they relate to.
Adding line number will help to make this identification easier.
Support assumptions and caveats written within function/class documentation:
Empty newlines are removed from detailed assumption and caveat descriptions. These should be retained, to lead to newlines in the output Markdown.
Might be solved by only removing single newlines, but not double newlines?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.