Commit Graph
63 Commits
Author SHA1 Message Date
David Sangrey a9638f168e Bump Python Version to 3.14 2026-06-01 18:03:10 -04:00
David Sangrey cb93822470 Update Docs Pass 2026-01-19 12:22:24 -05:00
David Sangrey d00226f9e3 [2186] Additional Documentations 2024-04-05 17:20:05 -04:00
David Sangrey 247d632cc6 #2040 First Pass - Update Build System 2023-07-26 22:49:03 -04:00
Athanasius 2b79b89803 Contributing/Python-env: Note VSCode issue with pre-commit. 2022-12-21 13:10:01 +00:00
Athanasius 254988fd80 Contributing.md: Add 'Python Environment' section. 2022-12-21 13:05:36 +00:00
Athanasius 868c1d8e57 docs: Fix up references to setup.py to be to Build-exe-and-msi.py 2022-12-20 16:51:58 +00:00
Athanasius 80a8a32666 pytest/coverage: Improve the .toml comment about pragma 'inversion' 2022-10-02 12:38:24 +01:00
Athanasius 7aa832e3d1 Contributing.md: test coverage notes 2022-10-02 12:31:11 +01:00
Athanasius b108456ae3 Contributing: Add new section about plugin-only imports 2022-02-01 15:26:10 +00:00
Athanasius 9af6474d3c docs: Further config.py -> config tweaks 2022-01-31 15:45:40 +00:00
Athanasius 3e0c69be5e docs: Pass for config.py -> config/__init__.py and related changes 2022-01-31 15:41:25 +00:00
Athanasius f36d45d4bc Contributing: Add section on text formatting / .editorconfig 2022-01-27 16:36:41 +00:00
A_D 7bcf3a6f4d note sys.platform requirements in contributing 2022-01-26 18:51:50 +02:00
Athanasius 6968cd6c69 companion: Rename Auth.session to requests_session
So as to not confuse with companion.session.
2021-08-28 14:18:49 +01:00
Athanasius 4433b67c82 EDMarketConnector: Use logger.trace_if(...)
Yes, leaving that 'truncating plain logfile' as plain trace.
2021-08-13 15:14:03 +01:00
Athanasius 80976c8cf5 TRACE: Don't require --trace with other trace options
* `--trace-on ...` no longer requires `--trace` as well.
* Corrected check for `--trace-on *|all`.
* Updated Contributing.md to reflect mandated use of
  `logger.trace_if(...)`, with bare `logger.trace(...)` only for on the
  fly, code not going to be merged, use.
2021-08-13 11:55:10 +01:00
A_D 80fbfd1780 Updated docs containing info about trace-if 2021-08-12 16:46:26 +02:00
Athanasius 5ceac5ded7 Contributing.md: Fix doc of how to use trace_on 2021-08-11 12:47:00 +01:00
Athanasius c398be9b5c Contributing: Document --debug-send ... code and usage 2021-08-05 17:04:44 +01:00
Athanasius ca87c061a1 Contributing: Document --trace-on code and usage 2021-08-05 16:50:02 +01:00
Athanasius 9d46b6a7b0 Contributing: .format() still acceptable wrt translations 2021-06-07 12:58:45 +01:00
Athanasius d304c32602 Translations: LANG comment in here, not Contributing
Also changed to `# header` style formatting, with `---` separators
between major sections.
2021-06-07 12:47:48 +01:00
Athanasius da790826e9 Contributing: missing/incorrect docstrings will fail flake8 2021-06-07 12:33:12 +01:00
Athanasius f7272ee445 Contributing: fstrings are mandatory, not only preferred
Legacy code aside....
2021-06-07 12:32:12 +01:00
Athanasius e548dce4d8 Contributing: Reference Plugin logging documentation 2021-06-07 12:31:05 +01:00
Athanasius 522f15b0c6 Contributing: 'Coding Conventions' content shouldn't be headers 2021-06-07 12:27:45 +01:00
Athanasius 93dbaee5ae Contributing: "Git commit conventions" after "General workflow"
Also linkified to the GitHub docs about 'Closes #XXX' and the like.
2021-06-07 12:26:01 +01:00
Athanasius 81652a54c2 Contributing: --- separators between each ## 2021-06-07 12:21:00 +01:00
Athanasius 3c13e84910 Contributing: Re-arrange sections more logically
1. General workflow first.
2. Then branches, including 'work in progress'.
3. Followed by tags.
4. *Then* 'Version conventions'.
2021-06-07 12:18:56 +01:00
Athanasius 9dcb79a5db Contributing: Minor grammar/punctuation 2021-06-07 12:11:58 +01:00
Athanasius 54b57db329 Contributing: <type>/<issue number>/<title> now mandated 2021-06-07 12:10:43 +01:00
Athanasius 3edf4ed069 Contributing: re-format 'Work on Issues' 2021-06-07 12:04:14 +01:00
A_D 6b7cb2a366 Fixed overindented titles 2021-06-07 12:54:01 +02:00
A_D 9c4bc182ca Added LANG file generation and comment extraction 2021-06-07 12:43:16 +02:00
Athanasius 3975aa3e87 Contributing: Choose an appropriate logging level
Open to comments on my definitions.
2021-06-07 11:16:02 +01:00
Athanasius f6f5a8a8fe Contributing: Fix header levels after 'Scope changes' 2021-06-07 11:03:41 +01:00
A_D cd8319bfc6 Clarify size of giant 2021-05-27 11:18:31 +02:00
A_D 4643d95f26 Add HACK/MAGIC/WORKAROUND comments 2021-05-27 10:27:25 +02:00
Athanasius e0574e5584 Contributing.md: Minor pytest-related edits
* URL-ise some things.
* `` around some code.
2021-04-01 14:45:52 +01:00
Athanasius 0cae22e4a4 Contributing.md: Expand on unit test docs & set vim wordwrap.
* vim: modeline for 79 character line wrap
* Add some hints about running tests.
* Pointer to the pytest docs.
2021-04-01 14:45:52 +01:00
Athanasius 3a80d77997 Contributing.md: We use pytest and a particular file layout for tests. 2021-04-01 14:45:52 +01:00
A_D ee12b2073c fixed some sentence construction 2020-09-09 23:23:15 +02:00
A_D b50ed893ae Cleaned up and updated Contributing docs 2020-09-09 17:12:44 +02:00
Athanasius 3438867ad3 Docs: Reference Bug Report Template if applicable, not general issue URL. 2020-09-06 10:24:30 +01:00
Athanasius 66e2c354c7 Documentation update and getLogger() -> get_logger()
* Technically %(class)s can be e.g. A.B not just 'B' so say "name(s)".
* To not confuse EDMCLogging.getLogger() with logging.getLogger() it's
 been renamed to get_logger().
* Note how we signal errors with finding class and/or qualname.
* Call out EDMCLogging.py in Contributing.md.
2020-07-27 06:57:53 +01:00
Athanasius a82824c0e9 Contributing.md: Update logging docs for auto qualname and proper import 2020-07-27 06:57:52 +01:00
Athanasius fa1443b49c Contributing.md: Document use of logging.
Also fixes some camelCase to be proper snake_case in an example.
2020-07-27 06:57:23 +01:00
A_D 836a27fb96 Fixed code blocks 2020-07-24 13:45:17 +01:00
A_D f3d2098179 Updated docs
Added linting, testing, and new requirements-dev.txt instructions
2020-07-24 13:45:17 +01:00