Skip to content

Commit e8332dd

Browse files
author
github-actions
committed
Documentation update
1 parent dc8f611 commit e8332dd

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

docs/analyzers/gql004/index.html

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@
8484
</tbody>
8585
</table>
8686
<h2 id="cause" style="position:relative;"><a href="#cause" aria-label="cause permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Cause</h2>
87-
<p>One of the deprecated <code class="language-text">FieldXXX</code> methods that return <code class="language-text">FieldType</code> were used.</p>
87+
<ul>
88+
<li>One of the deprecated <code class="language-text">FieldXXX</code> methods that return <code class="language-text">FieldType</code> were used.</li>
89+
<li>Expression based <code class="language-text">Field</code> builder with <code class="language-text">nullable</code> and <code class="language-text">type</code> parameters was used.</li>
90+
</ul>
8891
<h2 id="rule-description" style="position:relative;"><a href="#rule-description" aria-label="rule description permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Rule description</h2>
8992
<p>A bunch of <code class="language-text">FieldXXX</code> APIs were deprecated and will be removed in future
9093
version. For more information see
@@ -94,7 +97,9 @@ <h2 id="how-to-fix-violations" style="position:relative;"><a href="#how-to-fix-v
9497
many <code class="language-text">FieldXXX</code> overloads, start configuring your field with one of the <code class="language-text">Field</code>
9598
methods defined on <code class="language-text">ComplexGraphType</code>. All such methods define a new field and
9699
return an instance of <code class="language-text">FieldBuilder&lt;T,U></code>. Then continue to configure the field
97-
with rich APIs provided by the returned builder.</p>
100+
with rich APIs provided by the returned builder.<br>
101+
For the expression based field builder, you need to use an overload with only
102+
<code class="language-text">nullable</code> or <code class="language-text">type</code> parameters.</p>
98103
<h2 id="example-of-a-violation" style="position:relative;"><a href="#example-of-a-violation" aria-label="example of a violation permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example of a violation</h2>
99104
<div class="gatsby-highlight" data-language="c#"><pre class="language-c#"><code class="language-c#">Field&lt;NonNullGraphType&lt;StringGraphType&gt;&gt;(
100105
&quot;name&quot;,
@@ -113,7 +118,9 @@ <h2 id="example-of-a-violation" style="position:relative;"><a href="#example-of-
113118
Description = &quot;id of the human&quot;
114119
}),
115120
resolve: async context =&gt; await data.GetHumanByIdAsync(context.GetArgument&lt;string&gt;(&quot;id&quot;))
116-
);</code></pre></div>
121+
);
122+
123+
Field(x =&gt; Name, true, typeof(StringGraphType));</code></pre></div>
117124
<h2 id="example-of-how-to-fix" style="position:relative;"><a href="#example-of-how-to-fix" aria-label="example of how to fix permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Example of how to fix</h2>
118125
<div class="gatsby-highlight" data-language="c#"><pre class="language-c#"><code class="language-c#">Field&lt;NonNullGraphType&lt;StringGraphType&gt;&gt;(&quot;name&quot;)
119126
.Description(&quot;Field description&quot;)
@@ -125,7 +132,9 @@ <h2 id="example-of-how-to-fix" style="position:relative;"><a href="#example-of-h
125132
Field&lt;HumanType&gt;(&quot;human&quot;)
126133
.Argument&lt;NonNullGraphType&lt;StringGraphType&gt;&gt;(&quot;id&quot;, &quot;id of the human&quot;)
127134
.ResolveAsync(async context =&gt; await data.GetHumanByIdAsync(context.GetArgument&lt;string&gt;(&quot;id&quot;)));
128-
</code></pre></div>
135+
136+
// remove the &#39;nullable&#39; argument because if was ignored by the obsolete overload
137+
Field(x =&gt; Name, typeof(StringGraphType));</code></pre></div>
129138
<h2 id="configure-code-fix" style="position:relative;"><a href="#configure-code-fix" aria-label="configure code fix permalink" class="anchor before"><svg aria-hidden="true" focusable="false" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Configure code fix</h2>
130139
<p>The given diagnostic rule offers an automatic code fix. By default, it attempts
131140
to retain the original user code formatting as much as possible but it will

0 commit comments

Comments
 (0)