diff options
author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2018-04-14 17:53:58 -0400 |
---|---|---|
committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2018-04-14 17:53:58 -0400 |
commit | c2cb76b79919261c4d7eab107c5cb77ec6c6a81c (patch) | |
tree | 74e0848fed6a29d7303c5422cae265d4f04b8700 /docs/mod-build-config.md | |
parent | 052ef9683a473ce2253f56ca6323abbc70ba9d76 (diff) | |
download | SMAPI-c2cb76b79919261c4d7eab107c5cb77ec6c6a81c.tar.gz SMAPI-c2cb76b79919261c4d7eab107c5cb77ec6c6a81c.tar.bz2 SMAPI-c2cb76b79919261c4d7eab107c5cb77ec6c6a81c.zip |
rewrite analyzers to match more cases, use readable warning IDs (#471)
Diffstat (limited to 'docs/mod-build-config.md')
-rw-r--r-- | docs/mod-build-config.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/mod-build-config.md b/docs/mod-build-config.md index 99a567f2..d942beeb 100644 --- a/docs/mod-build-config.md +++ b/docs/mod-build-config.md @@ -153,8 +153,8 @@ You can hide the warnings... See below for help with each specific warning. -### SMAPI001 -**Implicit net field conversion:** +### Avoid implicit net field cast +Warning text: > This implicitly converts '{{expression}}' from {{net type}} to {{other type}}, but > {{net type}} has unintuitive implicit conversion rules. Consider comparing against the actual > value instead to avoid bugs. @@ -185,8 +185,8 @@ Suggested fix: if (item != null && item.category.Value == 0) ``` -### SMAPI002 -**Avoid net fields when possible:** +### Avoid net field +Warning text: > '{{expression}}' is a {{net type}} field; consider using the {{property name}} property instead. Your code accesses a net field, which has some unusual behavior (see [SMAPI001](#smapi001)). This @@ -194,8 +194,8 @@ field has an equivalent non-net property that avoids those issues. Suggested fix: access the suggested property name instead. -### SMAPI003 -**Avoid obsolete fields:** +### Avoid obsolete field +Warning text: > The '{{old field}}' field is obsolete and should be replaced with '{{new field}}'. Your code accesses a field which is obsolete or no longer works. Use the suggested field instead. |