EDCD / EDCD/EDMarketConnector

Documentation to quickly check `--trace-on` implementations

Open
#1,438 0 comments 0 reactions 1 assignee Claimed by @Rixxan View on GitHub
devtools enhancement Staged
Dominant language
Python
Stars
1.3k
Forks
182
Avg merge
1m
Merged PRs (30d)
1

Description

Having to check the source in order to remember:
1. What `--trace-on` arguments are available.
2. What each one actually does
eats into developer time.

So, a modest proposal:

- [ ] Define a `# TRACEON` comment forma. Just a prefix probably, multiple consecutive lines comprising a single entry.
- [x] Python script utilising AST to scan all the source for `logger.trace_if(...)` invocations, and the attached comments. It should then output the results to a file in some format that ....
- [x] `--help trace-on`, or if needs be `--trace-on-help` will then consult that file and output the list and documentation. Can possibly also make it only output the relevant information for a given possibility.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.