Skip to content

markdig fixes - Part 2 #2552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 6, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -817,16 +817,14 @@ MsgBox(CStr(WebBrowserArray(1).Text))

- <xref:System.Windows.Forms.WebBrowser.GoSearch%2A>

-

You can handle the `Navigating` event to cancel navigation if certain conditions have not been met, for example, when the user has not completely filled out a form. To cancel navigation, set the `Cancel` property of the <xref:System.Windows.Forms.WebBrowserNavigatingEventArgs> object passed to the event handler to `true`. You can also use this object to retrieve the URL of the new document through the <xref:System.Windows.Forms.WebBrowserNavigatingEventArgs.Url%2A> property. If the new document will be displayed in a Web page frame, you can retrieve the name of the frame through the <xref:System.Windows.Forms.WebBrowserNavigatingEventArgs.TargetFrameName%2A> property.

Handle the <xref:Microsoft.VisualBasic.Compatibility.VB6.WebBrowserArray.Navigated> event to receive notification when the <xref:System.Windows.Forms.WebBrowser> control finishes navigation and has begun loading the document at the new location. Handle the <xref:Microsoft.VisualBasic.Compatibility.VB6.WebBrowserArray.DocumentCompleted> event to receive notification when the <xref:System.Windows.Forms.WebBrowser> control finishes loading the new document.

For more information about how to handle events, see [Handling and Raising Events](~/docs/standard/events/index.md).

> [!NOTE]
> Functions and objects in the <xref:Microsoft.VisualBasic.Compatibility.VB6> namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)]. They are necessary only when the Visual Basic 6.0 code model differs significantly from the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)] implementation.
> Functions and objects in the <xref:Microsoft.VisualBasic.Compatibility.VB6> namespace are provided for use by the tools for upgrading from Visual Basic 6.0 to Visual Basic. In most cases, these functions and objects duplicate functionality that you can find in other namespaces in the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)]. They are necessary only when the Visual Basic 6.0 code model differs significantly from the [!INCLUDE[dnprdnshort](~/includes/dnprdnshort-md.md)] implementation.

]]></format>
</remarks>
Expand Down
12 changes: 6 additions & 6 deletions xml/System.Activities/WorkflowIdentityFilter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@
## Remarks
This class supports the versioning and dynamic update functionality of Windows Workflow Foundation. For more information about workflow versioning, workflow identity, and dynamic update, see the following topics:

- [Workflow Versioning](~/docs/framework/windows-workflow-foundation/whats-new-in-wf-in-dotnet.md)
- [Workflow Versioning](~/docs/framework/windows-workflow-foundation/whats-new-in-wf-in-dotnet.md)
Describes the workflow versioning functionality introduced in [!INCLUDE[net_v45](~/includes/net-v45-md.md)].

- [Dynamic Update](~/docs/framework/windows-workflow-foundation/dynamic-update.md)
- [Dynamic Update](~/docs/framework/windows-workflow-foundation/dynamic-update.md)
Describes how to update the workflow definition of a persisted workflow instance by using dynamic update.

- [Using WorkflowApplication Identity and Versioning](~/docs/framework/windows-workflow-foundation/using-workflowidentity-and-versioning.md)
- [Using WorkflowApplication Identity and Versioning](~/docs/framework/windows-workflow-foundation/using-workflowidentity-and-versioning.md)
Describes how to use <xref:System.Activities.WorkflowIdentity> to host multiple versions of a workflow side-by-side.

- [Side by Side Versioning in WorkflowServiceHost](~/docs/framework/wcf/feature-details/side-by-side-versioning-in-workflowservicehost.md)
- [Side by Side Versioning in WorkflowServiceHost](~/docs/framework/wcf/feature-details/side-by-side-versioning-in-workflowservicehost.md)
Describes how to host multiple versions of a workflow on a single endpoint.

- [How to: Host Multiple Versions of a Workflow Side-by-Side](~/docs/framework/windows-workflow-foundation/how-to-host-multiple-versions-of-a-workflow-side-by-side.md)
- [How to: Host Multiple Versions of a Workflow Side-by-Side](~/docs/framework/windows-workflow-foundation/how-to-host-multiple-versions-of-a-workflow-side-by-side.md)
This step in the [Getting Started Tutorial](~/docs/framework/windows-workflow-foundation/getting-started-tutorial.md) demonstrates updating a workflow definition, and hosting workflows using both the old and new definition at the same time.

- [How to: Update the Definition of a Running Workflow Instance](~/docs/framework/windows-workflow-foundation/how-to-update-the-definition-of-a-running-workflow-instance.md)
- [How to: Update the Definition of a Running Workflow Instance](~/docs/framework/windows-workflow-foundation/how-to-update-the-definition-of-a-running-workflow-instance.md)
This step in the [Getting Started Tutorial](~/docs/framework/windows-workflow-foundation/getting-started-tutorial.md) demonstrates updating persisted workflow instances to use a new workflow definition.

]]></format>
Expand Down
4 changes: 3 additions & 1 deletion xml/System.Net.Http/HttpClientHandler.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,12 @@ Starting with .NET Core 2.1, the <xref:System.Net.Http.SocketsHttpHandler?displa
```csharp
AppContext.SetSwitch("System.Net.Http.UseSocketsHttpHandler", false);
```

```vb
AppContext.SetSwitch("System.Net.Http.UseSocketsHttpHandler", False)
```
By defining the `System.Net.Http.UseSocketsHttpHandler` switch in the *.netcore.runtimeconfig.json* configuration file:

- By defining the `System.Net.Http.UseSocketsHttpHandler` switch in the *.netcore.runtimeconfig.json* configuration file:

```json
"runtimeOptions": {
Expand Down
29 changes: 17 additions & 12 deletions xml/System.Runtime.Loader/AssemblyLoadContext.xml
Original file line number Diff line number Diff line change
Expand Up @@ -460,20 +460,25 @@ For more information, see [How to use and debug assembly unloadability in .NET C
<format type="text/markdown"><![CDATA[

## Remarks
<xref:System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyName%2A> loads an assembly by resolving the <xref:System.Reflection.AssemblyName>. This triggers a full resolution. The resolution fallback sequence follows this process:
1. The method calls <xref:System.Runtime.Loader.AssemblyLoadContext.Load(System.Reflection.AssemblyName)>.
> [!IMPORTANT]
> <xref:System.Runtime.Loader.AssemblyLoadContext.Load(System.Reflection.AssemblyName)> must not call this method to prevent recursive stack overflow.
2. Unless the assembly is loaded or an exception is thrown, the method attempts to load the assembly in the default <xref:System.Runtime.Loader.AssemblyLoadContext>.
3. Unless the assembly is loaded or an exception is thrown, the method fires the <xref:System.Runtime.Loader.AssemblyLoadContext.Resolving> event.
4. Unless the assembly is loaded or an exception is thrown, the method fires the <xref:System.AppDomain.AssemblyResolve> event.

<xref:System.Runtime.Loader.AssemblyLoadContext.LoadFromAssemblyName%2A> loads an assembly by resolving the <xref:System.Reflection.AssemblyName>. This triggers a full resolution. The resolution fallback sequence follows this process:

1. The method calls <xref:System.Runtime.Loader.AssemblyLoadContext.Load(System.Reflection.AssemblyName)>.

> [!IMPORTANT]
> <xref:System.Runtime.Loader.AssemblyLoadContext.Load(System.Reflection.AssemblyName)> must not call this method to prevent recursive stack overflow.

2. Unless the assembly is loaded or an exception is thrown, the method attempts to load the assembly in the default <xref:System.Runtime.Loader.AssemblyLoadContext>.
3. Unless the assembly is loaded or an exception is thrown, the method fires the <xref:System.Runtime.Loader.AssemblyLoadContext.Resolving> event.
4. Unless the assembly is loaded or an exception is thrown, the method fires the <xref:System.AppDomain.AssemblyResolve> event.

> [!NOTE]
> <xref:System.IO.FileLoadException> is thrown if `assemblyRef` specifies the full assembly name, and the first assembly that matches the simple name has a incompatible version or culture. The loader does not continue probing for other assemblies that match the simple name.
> [!NOTE]
> <xref:System.IO.FileLoadException> is thrown if `assemblyRef` specifies the full assembly name, and the first assembly that matches the simple name has a incompatible version or culture. The loader does not continue probing for other assemblies that match the simple name.

Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:

Each <xref:System.Runtime.Loader.AssemblyLoadContext> can load only:
* One version of an executable assembly.
* One version of a satellite assembly for each culture.
* One version of an executable assembly.
* One version of a satellite assembly for each culture.

]]></format>
</remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.ServiceModel.Description.WsdlEndpointConversionContext> class represents the context in which the custom WSDL for an endpoint is either exported using <xref:System.ServiceModel.Description.IWsdlExportExtension?displayProperty=nameWithType> or imported using <xref:System.ServiceModel.Description.IWsdlImportExtension?displayProperty=nameWithType>. The following properties enable you to retrieve the WSDL document object model for the current WSDL:
The <xref:System.ServiceModel.Description.WsdlEndpointConversionContext> class represents the context in which the custom WSDL for an endpoint is either exported using <xref:System.ServiceModel.Description.IWsdlExportExtension?displayProperty=nameWithType> or imported using <xref:System.ServiceModel.Description.IWsdlImportExtension?displayProperty=nameWithType>.

The following properties enable you to retrieve the WSDL document object model for the current WSDL:

- The <xref:System.ServiceModel.Description.WsdlEndpointConversionContext.ContractConversionContext%2A> property gets the <xref:System.ServiceModel.Description.WsdlContractConversionContext?displayProperty=nameWithType> for the endpoint contract.

Expand All @@ -30,9 +32,7 @@

- The <xref:System.ServiceModel.Description.WsdlEndpointConversionContext.WsdlPort%2A> property gets the port for the current endpoint.

-

- The following methods enable you to add or remove custom WSDL elements to the appropriate scopes in the exported or imported WSDL:
The following methods enable you to add or remove custom WSDL elements to the appropriate scopes in the exported or imported WSDL:

- The <xref:System.ServiceModel.Description.WsdlEndpointConversionContext.GetFaultBinding%2A> method returns the fault binding for the specified fault.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,13 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin> class represents the style of the border skin used for a chart image. If you set the <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin.SkinStyle> property to None, no skin will be used. This is the default value for the <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin.SkinStyle> property.

The <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin> class represents the style of the border skin used for a chart image. If you set the <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin.SkinStyle> property to None, no skin will be used. This is the default value for the <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkin.SkinStyle> property.

> [!NOTE]
> The difference between the sets of border skin styles that use frames and follow either the naming convention "FrameThin*" or "FrameTitle*" (for example, <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkinStyle.FrameThin1> or <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkinStyle.FrameTitle1>) is the shape and thickness of their frames.
> The difference between the sets of border skin styles that use frames and follow either the naming convention "FrameThin\*" or "FrameTitle\*" (for example, <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkinStyle.FrameThin1> or <xref:System.Windows.Forms.DataVisualization.Charting.BorderSkinStyle.FrameTitle1>) is the shape and thickness of their frames.

In addition, if you use one of the "FrameThin" style border skins, the title of the chart will not be displayed. However, if you use one of the "FrameTitle" style border skins, the title of the chart will appear in the top-horizontal part of the frame.
In addition, if you use one of the "FrameThin" style border skins, the title of the chart will not be displayed. However, if you use one of the "FrameTitle" style border skins, the title of the chart will appear in the top-horizontal part of the frame.

]]></format>
</remarks>
Expand Down
17 changes: 8 additions & 9 deletions xml/System.Windows.Threading/DispatcherFrame.xml
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,14 @@
<format type="text/markdown"><![CDATA[

## Remarks
<xref:System.Windows.Threading.DispatcherFrame> typically fall into two categories:

- Long running, general purpose frames, that exit only when instructed to. These frames should exit when they are requested.

- Short running, very specific frames that exit when an important criteria is met. These frames may consider not exiting when they are requested in favor of waiting for their exit criteria to be met. These frames should have a time-out associated with them.

-

- At application shutdown, all frames are request to exit.

<xref:System.Windows.Threading.DispatcherFrame> typically fall into two categories:

- Long running, general purpose frames, that exit only when instructed to. These frames should exit when they are requested.

- Short running, very specific frames that exit when an important criteria is met. These frames may consider not exiting when they are requested in favor of waiting for their exit criteria to be met. These frames should have a time-out associated with them.

At application shutdown, all frames are requested to exit.

]]></format>
</remarks>
Expand Down
8 changes: 3 additions & 5 deletions xml/System/ArgumentOutOfRangeException.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
An <xref:System.ArgumentOutOfRangeException> exception is thrown when a method is invoked and at least one of the arguments passed to the method is not `null` and contains an invalid value that is not a member of the set of values expected for the argument. The <xref:System.ArgumentException.ParamName%2A> property identifies the invalid argument, and the <xref:System.ArgumentOutOfRangeException.ActualValue%2A> property, if a value is present, identifies the invalid value.
An <xref:System.ArgumentOutOfRangeException> exception is thrown when a method is invoked and at least one of the arguments passed to the method is not `null` and contains an invalid value that is not a member of the set of values expected for the argument. The <xref:System.ArgumentException.ParamName%2A> property identifies the invalid argument, and the <xref:System.ArgumentOutOfRangeException.ActualValue%2A> property, if a value is present, identifies the invalid value.

Typically, an <xref:System.ArgumentOutOfRangeException> results from developer error. Instead of handling the exception in a `try`/`catch` block, you should eliminate the cause of the exception or, if the argument is returned by a method call or input by the user before being passed to the method that throws the exception, you should validate arguments before passing them to the method.

Expand All @@ -60,7 +60,7 @@

- String manipulation methods in the <xref:System.String> class.

The conditions in which an <xref:System.ArgumentOutOfRangeException> exception is thrown include the following:
The conditions in which an <xref:System.ArgumentOutOfRangeException> exception is thrown include the following:

You are retrieving the member of a collection by its index number, and the index number is invalid.
This is the most common cause of an <xref:System.ArgumentOutOfRangeException> exception. Typically, the index number is invalid for one of three reasons:
Expand Down Expand Up @@ -132,9 +132,7 @@
[!code-csharp[System.ArgumentOutOfRangeException#18](~/samples/snippets/csharp/VS_Snippets_CLR_System/System.ArgumentOutOfRangeException/cs/NoFind2.cs#18)]
[!code-vb[System.ArgumentOutOfRangeException#18](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/System.ArgumentOutOfRangeException/vb/NoFind2.vb#18)]

-

You've attempted to extract a substring that is outside the range of the current string.
- You've attempted to extract a substring that is outside the range of the current string.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting (levels of indentation) in this topic is a complete disaster. I had started to make a list of items that you might easily fix if you wanted, but it's too extensive. I'll open an issue to fix it, and once this is merged, I'll address this issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good @rpetrusha. I've removed one file from this set of changes that needs to be merged after we switch the engine to markdig, otherwise, it breaks what we have right now.

The methods that extract substrings all require that you specify the starting position of the substring and, for substrings that do not continue to the end of the string, the number of characters in the substring. Note that this is not the *index* of the last character in the substring.

An <xref:System.ArgumentOutOfRangeException> exception is typically thrown in this case because you've incorrectly calculated the number of characters in the substring. If you are using a search method like <xref:System.String.IndexOf%2A?displayProperty=nameWithType> to identify the starting and ending positions of a substring:
Expand Down
Loading