Skip to content

Commit 7c89e92

Browse files
authored
Document in AGENTS.md reasoning for not using dead code analysis (#843)
1 parent 5a20b09 commit 7c89e92

3 files changed

Lines changed: 9 additions & 1 deletion

File tree

‎.github/workflows/appinspect.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ jobs:
2424
deps-group: lint
2525
- name: Run AppInspect
2626
uses: ./.github/actions/run-appinspect
27+
continue-on-error: ${{ github.event_name == 'pull_request' }}

‎AGENTS.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,10 @@ New code must not introduce regressions in tests.
6262

6363
Be concise and direct in your responses.
6464
Use hyphens (`-`) instead of em-dashes (`—`) in all generated text, comments, and documentation.
65+
66+
## Dead code
67+
68+
- SDK does not rely on any dead code detection, since this SDK is held to a backwards-compatibility contract:
69+
public API surface (classes, functions, methods) can appear unused within this repo while still being consumed
70+
by external callers. Do not remove code solely because it looks unreferenced internally - check whether it's
71+
part of the public API first.

‎tests/integration/test_kvstore_data.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def test_params_data_type_conversion(self):
7979
)
8080
for x in range(50):
8181
self.col.insert(json.dumps({"_key": str(x), "data": str(x), "ignore": x}))
82-
data = self.col.query(sort="data:-1", limit=20, fields="data,_id:0", skip=10)
82+
data = self.col.query(sort="data:-1", limit=20, fields="data", skip=10)
8383
self.assertEqual(len(data), 20)
8484
for x in range(20):
8585
self.assertEqual(data[x]["data"], 39 - x)

0 commit comments

Comments
 (0)