Skip to content
This repository was archived by the owner on Mar 2, 2025. It is now read-only.

Commit 5cfb50a

Browse files
committed
Add more info about disabling SonarCloud alerting
1 parent 52c102a commit 5cfb50a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,11 @@ Bug Tracker and Support
238238
Unit-Tests and Development
239239
--------------------------
240240

241-
We are manually disabling some [SonarCloud](https://sonarcloud.io/) alerts with `#pragma warning disable S1313`, where `S1313` is a False-positive that [SonarCloud](https://sonarcloud.io) flags in [CiscoConfParse](https://github.com/mpenning/ciscoconfparse/)
241+
- We are manually disabling some [SonarCloud](https://sonarcloud.io/) alerts with:
242+
- `#pragma warning disable S1313`
243+
- `#pragma warning restore S1313`
244+
- Where `S1313` is a False-positive that [SonarCloud](https://sonarcloud.io) flags in [CiscoConfParse](https://github.com/mpenning/ciscoconfparse/).
245+
- Those `#pragma warning` lines should be carefully-fenced to ensure that we don't disable a [SonarCloud](https://sonarcloud.io/) alert that is useful.
242246

243247
The project\'s [test workflow][1] checks ciscoconfparse on Python versions 3.7 and higher, as well as a [pypy JIT][22] executable.
244248

0 commit comments

Comments
 (0)