some miscellaneous docs improvements #3080
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| ```csharp | ||
| [AttributeUsage(AttributeTargets.Class)] | ||
| internal class TypeFormatterSourceAttribute : Attribute |
There was a problem hiding this comment.
Would it be better to add a link to the source file for TypeFormatterSourceAttribute here instead (so that it always reflects the latest API)?
There was a problem hiding this comment.
It won't change, and the readability is clearer to have it on the doc.
| return false; | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
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/)) | ✅ | |
There was a problem hiding this comment.
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 😄
shyamnamboodiripad
approved these changes
Jul 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR makes a few improvements to the developer guide and README and also adds docs for attribute-based formatter registration.