Add CODE_STYLE.md #623
Open
Add CODE_STYLE.md #623
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #623 +/- ##
==========================================
+ Coverage 73.11% 73.28% +0.16%
==========================================
Files 63 63
Lines 4077 4069 -8
==========================================
+ Hits 2981 2982 +1
+ Misses 1096 1087 -9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ilaflott
reviewed
Aug 27, 2025
ilaflott
requested changes
Aug 29, 2025
|
@ilaflott I'll be updating the style guide to address your comments, just not immediately as I have other priority tasks. Just want you to know I saw this! |
ceblanton
requested changes
Sep 3, 2025
ceblanton
reviewed
Sep 10, 2025
| .. warning:: This is a warning | ||
| """ | ||
|
|
||
| #this is an example of type hinting a variable |
There was a problem hiding this comment.
type hinting for variables outside of method declarations- too much?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Documentation has been a docus during the latest
fre-clidevelopment cycle. This PR adds a style guide defining specific rules to follow when documenting.Future improvements to this style guide can include a reference to specific PEP standards to follow in this repository.
Issue ticket number and link (if applicable)
I didn't start with an issue - I can if needed!
Checklist before requesting a review