Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

STYLE: use indented doctest format as code-style #16

Closed
reactive-firewall opened this issue Jan 26, 2022 · 1 comment
Closed

STYLE: use indented doctest format as code-style #16

reactive-firewall opened this issue Jan 26, 2022 · 1 comment
Assignees
@reactive-firewall
Labels
documentation Improvements or additions to documentation Linter Any linter tool or setting file enhancements Multicast Any main project file changes Python Lang Changes to Python source code

Comments

@reactive-firewall
Copy link
Owner

reactive-firewall commented Jan 26, 2022 •
edited
Loading

🤔 if this is the new style it should be enforced everywhere in our code, otherwise it is an antipatern to be random.

Originally posted by @reactive-firewall in #11 (comment)

👍 GOOD

"""
Test description

	>>> indented test code
	Test Result

"""

🙅 BAD

"""
Test description

>>> unindented test code
Test Result

"""
@reactive-firewall reactive-firewall added documentation Improvements or additions to documentation Linter Any linter tool or setting file enhancements Multicast Any main project file changes Python Lang Changes to Python source code labels Jan 26, 2022
@reactive-firewall reactive-firewall pinned this issue Jan 26, 2022
@reactive-firewall reactive-firewall mentioned this issue Jan 26, 2022
Merged
32 tasks
@reactive-firewall reactive-firewall self-assigned this Mar 1, 2022
@reactive-firewall
Copy link
Owner Author

resolved by https://gist.github.com/reactive-firewall/856ba9c244aece38df4df274c25a850f

@reactive-firewall reactive-firewall unpinned this issue Mar 2, 2022
reactive-firewall added a commit that referenced this issue Mar 8, 2022
@reactive-firewall
[MERGE] Release canidit for Version 1.3.0
82df954 
Initial Stable Base

 - b93f1a6 & 3bea4e8 Initial Setup Scripts and Configs
 - 7758e33 Initial `Makefile`...
 - c03fe27 Initial `README` Document
 - 73f2ce1 Initial requirements file (for python dependancies)
 - 35bd95c Initail `CI` settings for all the things 🎉
 - 60a5685 & a182d34 & 067a294 Initial Tests
   + New project Github Actions for CI testing #10
   + New Minimal Acceptance Testing 731726b
   + New user-install option 53e8a8f
   + Fix for project Build Testing
   + Fix for project Testing Coverage 60dfe04
   + Fix for User-Install Testing ( see #26 )
   + ...and More ( see #1 & #15 & #17 & #29 )

 - 8fc88a8 Cleaned up numerous anti-patterns
 - 4354c2c improved stability of `make clean`
 - 5c94cc7 fix for typos
 - 241922e Fixes for cli argument wrangling ( see #28 & #34 )
 - 7d03fef & 8ba92c3 & b49aee5 Reduced some complexity in test utilities
 - 1ddaa5a Renamed tests by new convention ( see #34 )
 - ...and improved stability throughout project

 - 4ec2e21 & fe25e79 & d7a8ea5 Dropped Travis-CI support due to paywall.
 - 0698978 Python 3.10+ not stable at this time ( see #29 )
 - fd8772e (BREAK-FIX) EOL python 2.x (and so deprecates unstable `setup.py test`)

Initial Point of passing initial tests and such (caveat: low code-coverage)
- [x] Closes #2
- [x] Closes #3
- [x] Closes #4
- [x] Closes #6
- [x] Closes #7
- [x] Closes #8
- [x] Resolved #9
- [x] Closes #12
- [x] Opens #13 🏷️
- [x] Closes #14
- [x] Closes #16
- [x] Closes #17
- [x] Opens #18 🏷️
- [x] Closes #21
- [x] Closes #22
- [x] Closes #23
- [x] Opens #24 🏷️
- [x] Opens #25 🏷️
  - [x] Closes #19
  - [x] Opens #20 🏷️
  - [x] Closes #28
  - [x] Closes #15
- [x] Opens #26 🏷️
- [x] Opens #27 🏷️
- [x] Closes #29
- [x] Closes #30
- [x] Opens #31 🏷️
- [x] Opens #32 🏷️
- [x] Opens #33
- [x] Closes #34
- [x] Opens #35 🏷️
- [x] Closes #36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@reactive-firewall reactive-firewall

Labels
documentation Improvements or additions to documentation Linter Any linter tool or setting file enhancements Multicast Any main project file changes Python Lang Changes to Python source code
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@reactive-firewall