Fixes around backticks by svick · Pull Request #2711 · dotnet/docs

svick · 2017-07-23T13:27:16Z

I have searched the docs for uninterrupted sequences of letter-backtick-letter and fixed those that I though were wrong. That means:

Adding a space before and after code.
Moving backtick that's incorrectly in the middle of a word.
Other fixes.

rpetrusha

Thanks for making all of these changes, @svick! We'll merge after the update to live PR builds and is merged.

guardrex

@rpetrusha Ooops ... I thought I'd save u some time by reviewing. I'm opening a pair of side issues for some things to fix not directly related here, but I reached the same result u did on the review.

guardrex · 2017-07-24T17:49:10Z

docs/framework/data/adonet/ef/language-reference/aggregate-canonical-functions.md

 |`Count(` `expression` `)`|Returns the size of the aggregate including null and duplicate values.<br /><br /> **Arguments**<br /><br /> Any type.<br /><br /> **Return Value**<br /><br /> An `Int32`.<br /><br /> **Example**<br /><br /> [!code-csharp[DP EntityServices Concepts#EDM_COUNT](../../../../../../samples/snippets/csharp/VS_Snippets_Data/dp entityservices concepts/cs/entitysql.cs#edm_count)]
 [!code-sql[DP EntityServices Concepts#EDM_COUNT](../../../../../../samples/snippets/tsql/VS_Snippets_Data/dp entityservices concepts/tsql/entitysql.sql#edm_count)]|  
-|`Max(` `expression` `)`|Returns the maximum of the non-null values.<br /><br /> **Arguments**<br /><br /> A`Byte`, `Int16`, `Int32`, `Int64`, `Byte`, `Single`, `Double`, `Decimal`, `DateTime`, `DateTimeOffset`, `Time`, `String`, `Binary`.<br /><br /> **Return Value**<br /><br /> The type of `expression`. `Null`, if all input values are `null` values.<br /><br /> **Example**<br /><br /> [!code-csharp[DP EntityServices Concepts#EDM_MAX](../../../../../../samples/snippets/csharp/VS_Snippets_Data/dp entityservices concepts/cs/entitysql.cs#edm_max)]
+|`Max(` `expression` `)`|Returns the maximum of the non-null values.<br /><br /> **Arguments**<br /><br /> A `Byte`, `Int16`, `Int32`, `Int64`, `Byte`, `Single`, `Double`, `Decimal`, `DateTime`, `DateTimeOffset`, `Time`, `String`, `Binary`.<br /><br /> **Return Value**<br /><br /> The type of `expression`. `Null`, if all input values are `null` values.<br /><br /> **Example**<br /><br /> [!code-csharp[DP EntityServices Concepts#EDM_MAX](../../../../../../samples/snippets/csharp/VS_Snippets_Data/dp entityservices concepts/cs/entitysql.cs#edm_max)]


I would suggest manually combining for this file ...

`Max(expression)`

... but the whole topic needs a little 💓, so I opened: #2738

guardrex · 2017-07-24T17:57:44Z

docs/framework/data/adonet/ef/string-functions.md

+|`PATINDEX(` `'%pattern%'`, `expression` `)`|Returns the starting position of the first occurrence of a pattern in a specified `String` expression.<br /><br /> **Arguments**<br /><br /> `'%pattern%'`: An ASCII or Unicode `String` type. Wildcard characters can be used; however, the % character must come before and after pattern (except in searches for first or last characters).<br /><br /> `expression`: An ASCII or Unicode `String` to search for the specified pattern.<br /><br /> **Return Value**<br /><br /> An `Int32`.<br /><br /> **Example**<br /><br /> `SqlServer.PATINDEX('abc', 'ab')`|  
+|`QUOTENAME(` `'char_string'` [, `'quote_char'`]`)`|Returns a Unicode `String` with the delimiters added to make the input string a valid SQL Server 2005 delimited identifier.<br /><br /> **Arguments**<br /><br /> `char_string`: A Unicode `String`.<br /><br /> `quote_char`: A one-character string to use as the delimiter. Can be a single quotation mark ( ' ), a left or right bracket ( [ ] ), or a double quotation mark ( " ). If `quote_char` is not specified, brackets are used.<br /><br /> **Return Value**<br /><br /> A Unicode `String`.<br /><br /> **Example**<br /><br /> `SqlServer.QUOTENAME('abc[]def')`|  
+|`REPLACE(` `expression1`, `expression2`, `expression3` `)`|Repeats a character expression for a specified number of times.<br /><br /> **Arguments**<br /><br /> `expression1`: The string expression to be searched. string_expression1 can be of a Unicode or an ASCII String type.<br /><br /> `expression2`:The substring to be found. string_expression2 can be of a Unicode or an ASCII String type.<br /><br /> `expression3`; The replacement string. string_expression3 can be of a Unicode or an ASCII String type.<br /><br /> **Example**<br /><br /> `SqlServer.REPLACE('aabbcc', 'bc', 'zz')`|  
+|`REPLICATE(` `char_expression`, `int_expression` `)`|Repeats a character expression for a specified number of times.<br /><br /> **Arguments**<br /><br /> `char_expression`: A Unicode or ASCII `String` type.<br /><br /> `int_expression`: `Int64` (not supported in SQL Server 2000) or `Int32`.<br /><br /> **Return Value**<br /><br /> A Unicode or ASCII `String` type.<br /><br /> **Example**<br /><br /> `SqlServer.REPLICATE('aa',2)`|  


@svick With this topic, the table is ok, but do u prefer to manually change the inline code references (combine the little pieces)? ... or do u prefer to open a new issue like I did for the other one?

In case u prefer to open a new issue, the topic references are:

https://docs.microsoft.com/en-us/dotnet/framework/data/adonet/ef/string-functions
docs/framework/data/adonet/ef/string-functions.md

I'm not going to hold up approval, so it will be up to you the best way to proceed.

@guardrex Done.

guardrex · 2017-07-24T18:10:31Z

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

 |`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.|  
 |**/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)](../../../docs/framework/tools/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.|  
-|**/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)](~/docs/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.|  
+|**/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)](~/docs/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.|  


@svick I see a few little things on this topic not directly relevant to your PR. I'll get 'um ... I'm looking for some small fill-in thingies to do before I go. I don't want to hold this set of changes up. I'll work it on: #2739

guardrex · 2017-07-24T18:15:27Z

docs/framework/tools/ildasm-exe-il-disassembler.md

 |**/forward**|Uses forward class declaration.|  
 |**/headers**|Includes file header information in the output.|  
-|**/item:** *class*[**::** *member*[`(`*sig*]]|Disassembles the following depending upon the argument supplied:<br /><br /> -   Disassembles the specified *class*.<br />-   Disassembles the specified `member`of the *class*.<br />-   Disassembles the `member`of the *class* with the specified signature *sig*. The format of *sig* is:<br />     [`instance`] `returnType`(`parameterType1`, `parameterType2`, …, `parameterTypeN`)<br />     **Note** In the .NET Framework versions 1.0 and 1.1, `sig` must be followed by a closing parenthesis: (`sig`). Starting with the Net Framework 2.0 the closing parenthesis must be omitted: (`sig`.|  
+|**/item:** *class*[**::** *member*[`(`*sig*]]|Disassembles the following depending upon the argument supplied:<br /><br /> -   Disassembles the specified *class*.<br />-   Disassembles the specified `member` of the *class*.<br />-   Disassembles the `member` of the *class* with the specified signature *sig*. The format of *sig* is:<br />     [`instance`] `returnType`(`parameterType1`, `parameterType2`, …, `parameterTypeN`)<br />     **Note** In the .NET Framework versions 1.0 and 1.1, `sig` must be followed by a closing parenthesis: (`sig`). Starting with the Net Framework 2.0 the closing parenthesis must be omitted: (`sig`.|  


Same here ... I plan to have a follow-up look at this later in the week on: #2739

guardrex · 2017-07-24T19:16:53Z

Thanks @svick.

Fixes around backticks

d4ffa11

dnfclas added the cla-already-signed label Jul 23, 2017

guardrex self-requested a review July 24, 2017 17:52

rpetrusha approved these changes Jul 24, 2017

View reviewed changes

rpetrusha added the merge-on-hold-for-live-update label Jul 24, 2017

guardrex approved these changes Jul 24, 2017

View reviewed changes

Combine code spans in EF String Functions

701e5b0

svick force-pushed the backticks branch from 2054bff to 701e5b0 Compare July 24, 2017 19:11

guardrex removed the merge-on-hold-for-live-update label Jul 24, 2017

guardrex merged commit 0e0ae75 into dotnet:master Jul 24, 2017

svick deleted the backticks branch July 25, 2017 02:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes around backticks#2711

Fixes around backticks#2711
guardrex merged 2 commits intodotnet:masterfrom
svick:backticks

svick commented Jul 23, 2017

Uh oh!

rpetrusha left a comment

Uh oh!

guardrex left a comment

Uh oh!

guardrex Jul 24, 2017

Uh oh!

guardrex Jul 24, 2017

Uh oh!

svick Jul 24, 2017

Uh oh!

guardrex Jul 24, 2017

Uh oh!

guardrex Jul 24, 2017

Uh oh!

guardrex commented Jul 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

svick commented Jul 23, 2017

Uh oh!

rpetrusha left a comment

Choose a reason for hiding this comment

Uh oh!

guardrex left a comment

Choose a reason for hiding this comment

Uh oh!

guardrex Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

guardrex Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

svick Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

guardrex Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

guardrex Jul 24, 2017

Choose a reason for hiding this comment

Uh oh!

guardrex commented Jul 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants