Skip to content

Commit 0284814

Browse files
authored
Update *.md files to address some correctness/style issues reported by the next markdownlint release's MD037/no-space-in-emphasis rule. (#18341)
1 parent c980e11 commit 0284814

File tree

12 files changed

+49
-34
lines changed

12 files changed

+49
-34
lines changed

docs/csharp/misc/cs0436.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.assetid: c4135d9d-3511-4bbc-9540-48c2091f869c
1010
# Compiler Warning (level 2) CS0436
1111
The type 'type' in 'assembly' conflicts with the imported type 'type2' in 'assembly'. Using the type defined in 'assembly'.
1212

13-
This warning is issued when a type in a source file (file_2) conflicts with an imported type in file _1. The compiler uses the one in the source file.
13+
This warning is issued when a type in a source file (file_2) conflicts with an imported type in file_1. The compiler uses the one in the source file.
1414

1515
## Example
1616

docs/csharp/misc/cs0437.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.assetid: cba5c9b6-a0bc-4f19-b1f0-c1f66436ee91
1010
# Compiler Warning (level 2) CS0437
1111
The type 'type' in 'assembly2' conflicts with the imported namespace 'namespace' in 'fassembly1'. Using the type defined in 'assembly'.
1212

13-
This warning is issued when a type in a source file, file_2, conflicts with an imported namespace in file _1. The compiler uses the type in the source file.
13+
This warning is issued when a type in a source file, file_2, conflicts with an imported namespace in file_1. The compiler uses the type in the source file.
1414

1515
## Example
1616

docs/framework/data/adonet/ef/language-reference/how-entity-sql-differs-from-transact-sql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ SELET Tab.a FROM Tab
104104
p.Address.City
105105
```
106106

107-
## No Support for *
108-
Transact-SQL supports the unqualified * syntax as an alias for the entire row, and the qualified \* syntax (t.\*) as a shortcut for the fields of that table. In addition, Transact-SQL allows for a special count(\*) aggregate, which includes nulls.
107+
## No Support for \*
108+
Transact-SQL supports the unqualified \* syntax as an alias for the entire row, and the qualified \* syntax (t.\*) as a shortcut for the fields of that table. In addition, Transact-SQL allows for a special count(\*) aggregate, which includes nulls.
109109

110110
[!INCLUDE[esql](../../../../../../includes/esql-md.md)] does not support the * construct. Transact-SQL queries of the form `select * from T` and `select T1.* from T1, T2...` can be expressed in [!INCLUDE[esql](../../../../../../includes/esql-md.md)] as `select value t from T as t` and `select value t1 from T1 as t1, T2 as t2...`, respectively. Additionally, these constructs handle inheritance (value substitutability), while the `select *` variants are restricted to top-level properties of the declared type.
111111

docs/framework/migration-guide/net-framework-4-migration-issues.md

Lines changed: 22 additions & 22 deletions
Large diffs are not rendered by default.

docs/framework/tools/al-exe-assembly-linker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ You can specify one or more of the following `sources`.
3232
| Source | Description |
3333
| ------ | ----------- |
3434
|`file`[,`target`]|Copies the contents of `file` (a module) to the file name specified by `target`. After copying, *Al.exe* compiles `target` into an assembly.|
35-
|**/embed[resource]:** `file`[,`name`[,`private`]]|Embeds the resource specified by `file` in the image that contains the assembly manifest; *Al.exe* copies the contents of `file` into the portable executable (PE) image.<br /><br /> The `name` parameter is an internal identifier for the resource. By default, resources are public in the assembly (visible to other assemblies). Specifying `private` makes the resource not visible to other assemblies.<br /><br /> If `file` is a .NET Framework resource file created, for example, by the [Resource File Generator (*Resgen.exe*)](resgen-exe-resource-file-generator.md) or in the development environment, it can be accessed with members in the <xref:System.Resources>. For more information, see <xref:System.Resources.ResourceManager>. For all other resources, use the `GetManifestResource`* methods in the <xref:System.Reflection.Assembly> to access the resource at run time.<br /><br /> If only resource files are passed to *Al.exe*, the output file is a satellite resource assembly.|
36-
|**/link[resource]:** `file`[,`name`[,`target`[,`private`]]]|Links a resource file to an assembly. The resource specified by `file` becomes part of the assembly; the file is not copied. The `file` parameter can be in any file format. For example, you can specify a native DLL as the `file` parameter. This will make the native DLL part of the assembly so that it can be installed into the global assembly cache and accessed from managed code in the assembly. You can also do this by using the **/linkresource** compiler option. For more information, see [-linkresource (C# Compiler Options)](../../csharp/language-reference/compiler-options/linkresource-compiler-option.md).<br /><br /> The `name` parameter is an internal identifier for the resource. The `target` parameter specifies a path and file name into which *Al.exe* copies the `file`*.* After copying, *Al.exe* compiles `target` into an assembly. By default, resources are public in the assembly (visible to other assemblies). Specifying `private` makes the resource not visible to other assemblies.<br /><br /> If `file` is a .NET Framework resource file created, for example, by the Resource File Generator (*Resgen.exe*) or in the development environment, it can be accessed with members in the <xref:System.Resources> namespace. For more information, see <xref:System.Resources.ResourceManager>. For all other resources, use the `GetManifestResource` * methods in the <xref:System.Reflection.Assembly> class to access the resource at run time.<br /><br /> If only resource files are passed to *Al.exe*, the output file is a satellite resource assembly.|
35+
|**/embed[resource]:** `file`[,`name`[,`private`]]|Embeds the resource specified by `file` in the image that contains the assembly manifest; *Al.exe* copies the contents of `file` into the portable executable (PE) image.<br /><br /> The `name` parameter is an internal identifier for the resource. By default, resources are public in the assembly (visible to other assemblies). Specifying `private` makes the resource not visible to other assemblies.<br /><br /> If `file` is a .NET Framework resource file created, for example, by the [Resource File Generator (*Resgen.exe*)](resgen-exe-resource-file-generator.md) or in the development environment, it can be accessed with members in the <xref:System.Resources>. For more information, see <xref:System.Resources.ResourceManager>. For all other resources, use the `GetManifestResource*` methods in the <xref:System.Reflection.Assembly> to access the resource at run time.<br /><br /> If only resource files are passed to *Al.exe*, the output file is a satellite resource assembly.|
36+
|**/link[resource]:** `file`[,`name`[,`target`[,`private`]]]|Links a resource file to an assembly. The resource specified by `file` becomes part of the assembly; the file is not copied. The `file` parameter can be in any file format. For example, you can specify a native DLL as the `file` parameter. This will make the native DLL part of the assembly so that it can be installed into the global assembly cache and accessed from managed code in the assembly. You can also do this by using the **/linkresource** compiler option. For more information, see [-linkresource (C# Compiler Options)](../../csharp/language-reference/compiler-options/linkresource-compiler-option.md).<br /><br /> The `name` parameter is an internal identifier for the resource. The `target` parameter specifies a path and file name into which *Al.exe* copies the `file`*.* After copying, *Al.exe* compiles `target` into an assembly. By default, resources are public in the assembly (visible to other assemblies). Specifying `private` makes the resource not visible to other assemblies.<br /><br /> If `file` is a .NET Framework resource file created, for example, by the Resource File Generator (*Resgen.exe*) or in the development environment, it can be accessed with members in the <xref:System.Resources> namespace. For more information, see <xref:System.Resources.ResourceManager>. For all other resources, use the `GetManifestResource*` methods in the <xref:System.Reflection.Assembly> class to access the resource at run time.<br /><br /> If only resource files are passed to *Al.exe*, the output file is a satellite resource assembly.|
3737

3838
You can specify the following `options`; you must specify **/out**.
3939

docs/framework/unmanaged-api/profiling/icorprofilerinfo3-requestprofilerdetach-method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ HRESULT RequestProfilerDetach(
3636
|HRESULT|Description|
3737
|-------------|-----------------|
3838
|S_OK|The detach request is valid, and the detach procedure is now continuing on another thread. When the detach is fully complete, a `ProfilerDetachSucceeded` event is issued.|
39-
|E_ CORPROF_E_CALLBACK3_REQUIRED|The profiler failed an [IUnknown::QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)) attempt for the [ICorProfilerCallback3](icorprofilercallback3-interface.md) interface, which it must implement to support the detach operation. Detach was not attempted.|
39+
|E_CORPROF_E_CALLBACK3_REQUIRED|The profiler failed an [IUnknown::QueryInterface](/windows/win32/api/unknwn/nf-unknwn-iunknown-queryinterface(q)) attempt for the [ICorProfilerCallback3](icorprofilercallback3-interface.md) interface, which it must implement to support the detach operation. Detach was not attempted.|
4040
|CORPROF_E_IMMUTABLE_FLAGS_SET|Detachment is impossible because the profiler set immutable flags at startup. Detachment was not attempted; the profiler is still fully attached.|
4141
|CORPROF_E_IRREVERSIBLE_INSTRUMENTATION_PRESENT|Detachment is impossible because the profiler used instrumented Microsoft intermediate language (MSIL) code, or inserted `enter`/`leave` hooks. Detachment was not attempted; the profiler is still fully attached.<br /><br /> **Note** Instrumented MSIL is code is code that is provided by the profiler using the [SetILFunctionBody](icorprofilerinfo-setilfunctionbody-method.md) method.|
4242
|CORPROF_E_RUNTIME_UNINITIALIZED|The runtime has not been initialized yet in the managed application. (That is, the runtime has not been fully loaded.) This error code may be returned when detachment is requested inside the profiler callback's [ICorProfilerCallback::Initialize](icorprofilercallback-initialize-method.md) method.|

docs/fsharp/language-reference/query-expressions.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,11 +537,14 @@ query {
537537
<td><code>EXISTS</code>
538538
<br />
539539

540+
<!-- markdownlint-capture -->
541+
<!-- markdownlint-disable no-space-in-emphasis -->
540542
<pre><code class="lang-sql">SELECT * FROM Student
541543
WHERE EXISTS
542544
(SELECT * FROM CourseSelection
543545
WHERE CourseSelection.StudentID = Student.StudentID)
544546
</code></pre>
547+
<!-- markdownlint-restore -->
545548
</td>
546549

547550
<td>
@@ -602,11 +605,14 @@ query {
602605
</td></tr><tr><td>
603606
Grouping with count condition.<br/>
604607

608+
<!-- markdownlint-capture -->
609+
<!-- markdownlint-disable no-space-in-emphasis -->
605610
<pre><code class="lang-sql">SELECT Student.Age, COUNT( * )
606611
FROM Student
607612
GROUP BY Student.Age
608613
HAVING COUNT( * ) > 1
609614
</code></pre>
615+
<!-- markdownlint-restore -->
610616

611617
</td><td>
612618

@@ -646,12 +652,15 @@ query {
646652
</td></tr><tr><td>
647653
Grouping, counting, and ordering by count.<br/>
648654

655+
<!-- markdownlint-capture -->
656+
<!-- markdownlint-disable no-space-in-emphasis -->
649657
<pre><code class="lang-sql">SELECT Student.Age, COUNT( * ) as myCount
650658
FROM Student
651659
GROUP BY Student.Age
652660
HAVING COUNT( * ) > 1
653661
ORDER BY COUNT( * ) DESC
654662
</code></pre>
663+
<!-- markdownlint-restore -->
655664

656665
</td><td>
657666

@@ -939,10 +948,13 @@ query {
939948

940949
</td></tr><tr><td><code>UNION</code> of two queries.<br/>
941950

951+
<!-- markdownlint-capture -->
952+
<!-- markdownlint-disable no-space-in-emphasis -->
942953
<pre><code class="lang-sql">SELECT * FROM Student
943954
UNION
944955
SELECT * FROM lastStudent
945956
</code></pre>
957+
<!-- markdownlint-restore -->
946958

947959
</td><td>
948960

@@ -964,10 +976,13 @@ query2.Union (query1)
964976

965977
</td></tr><tr><td>Intersection of two queries.<br/>
966978

979+
<!-- markdownlint-capture -->
980+
<!-- markdownlint-disable no-space-in-emphasis -->
967981
<pre><code class="lang-sql">SELECT * FROM Student
968982
INTERSECT
969983
SELECT * FROM LastStudent
970984
</code></pre>
985+
<!-- markdownlint-restore -->
971986
</td><td>
972987

973988
<pre><code class="lang-fsharp">

docs/standard/data/xml/xmlschemavalidator-push-based-validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ The following table describes how the punctuation symbols found in the state tra
450450
|------------|-----------------|
451451
|&#124;|Either method or state (the one before the bar or the one after it) can be called.|
452452
|?|The method or state that precedes the question mark is optional but if it is called it can only be called once.|
453-
|*|The method or state that precedes the * symbol is optional, and can be called more than once.|
453+
|\*|The method or state that precedes the \* symbol is optional, and can be called more than once.|
454454

455455
## Validation Context
456456

docs/standard/language-independence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Non-compliant type | Description | CLS-compliant alternative
336336

337337
The .NET Framework Class Library or any other class library may include other types that aren't CLS-compliant; for example:
338338

339-
* Boxed value types. The following C# example creates a class that has a public property of type `int`* named `Value`. Because an `int`* is a boxed value type, the compiler flags it as non-CLS-compliant.
339+
* Boxed value types. The following C# example creates a class that has a public property of type `int*` named `Value`. Because an `int*` is a boxed value type, the compiler flags it as non-CLS-compliant.
340340

341341
```csharp
342342
using System;

0 commit comments

Comments
 (0)