Skip to content
This repository was archived by the owner on Apr 27, 2026. It is now read-only.

some miscellaneous docs improvements#3080

Merged
jonsequitur merged 1 commit into
dotnet:mainfrom
jonsequitur:docs-improvements-2023-07-11
Jul 11, 2023
Merged

some miscellaneous docs improvements#3080
jonsequitur merged 1 commit into
dotnet:mainfrom
jonsequitur:docs-improvements-2023-07-11

Conversation

@jonsequitur

Copy link
Copy Markdown
Contributor

This PR makes a few improvements to the developer guide and README and also adds docs for attribute-based formatter registration.

Comment thread docs/formatting.md

```csharp
[AttributeUsage(AttributeTargets.Class)]
internal class TypeFormatterSourceAttribute : Attribute

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would it be better to add a link to the source file for TypeFormatterSourceAttribute here instead (so that it always reflects the latest API)?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It won't change, and the readability is clearer to have it on the doc.

Comment thread docs/formatting.md
return false;
}
}
}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It may be a good idea to repeat the following snippet for the convention-based registration sample as well (for completeness / to avoid confusion).

[TypeFormatterSource(typeof(MyFormatterSource))]
public class MyTypeWithCustomFormatting
{
}

| PowerShell | ✅ |
| JavaScript | ✅ |
| SQL | ✅ |
| KQL ([Kusto Query Language](https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/)) | ✅ |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: This may just be my OCD but the 2nd | char on this line appears to be misaligned. Only mentioning since you fixed up the indentation for the corresponding | chars on other lines 😄

@jonsequitur
jonsequitur merged commit 67ea309 into dotnet:main Jul 11, 2023
@colombod colombod added the Area-Documentation Improvements or additions to documentation label Jul 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Area-Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants