Skip to content

Commit f2e21c7

Browse files
committed
Added false type checker warning note
1 parent 1504a52 commit f2e21c7

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

project-markers/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ print(project_markers)
3232
# => ['.ansible-lint', '.bazelrc', '.browserslistrc', '.buckconfig', ...]
3333
```
3434

35+
_Note: Most type checkers will falsely warn `project_markers` is not iterable because they cannot analyze runtime behavior (where the module is replaced w/ a list for cleaner, direct acces). You can safely suppress such warnings using `# type: ignore`._
36+
3537
The list includes markers from many tools and ecosystems, including:
3638

3739
- Version control (.git, .hg, .svn)

0 commit comments

Comments
 (0)