update md snippets #137
update md snippets #137
Conversation
| Source File: /README.source.md | ||
| To change this file edit the source file and then re-run the generation using either the dotnet global tool (https://github.com/SimonCropp/MarkdownSnippets#markdownsnippetstool) or using the api (https://github.com/SimonCropp/MarkdownSnippets#running-as-a-unit-test). | ||
| To change this file edit the source file and then run MarkdownSnippets. |
There was a problem hiding this comment.
I still like the unit test approach more (see comment below), but wonder what's the benefit of the .NET global tool over unit test.
There was a problem hiding this comment.
what's the benefit of the .NET global tool over unit test.
i didnt say there was. however i think there is a benefit of using msbuild over unit tests.
| @@ -591,6 +591,9 @@ II.2.12 <HandlesEvent />
 | |||
| <s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/UserRules/=XAML_005FFIELD/@EntryIndexedValue"><Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /></s:String> | |||
| <s:String x:Key="/Default/CodeStyle/Naming/XamlNaming/UserRules/=XAML_005FRESOURCE/@EntryIndexedValue"><Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /></s:String> | |||
| <s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpFileLayoutPatternsUpgrade/@EntryIndexedValue">True</s:Boolean> | |||
| <s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean> | |||
There was a problem hiding this comment.
These should not be here, right?
There was a problem hiding this comment.
yeah i will revert that part.
| [Fact] | ||
| public void Run() | ||
| { | ||
| DirectoryMarkdownProcessor.RunForFilePath(); |
There was a problem hiding this comment.
I'm not sure I like this option. It was very easy to run this test as a part of the test suite.
And I got it working (SimonCropp/MarkdownSnippets#66 (comment)).
|
@SimonCropp the |
|
Thank you for showing me the |
|
just to be clear. this PR does not force u to use the global tool. it uses the msbuild approach https://github.com/SimonCropp/MarkdownSnippets/blob/master/docs/msbuild.md |
|
Ah, sorry. Ok, then I'll review that as it might be even simpler to regenerate readme file. Perhaps less intuitive (more magic), but simpler. Thamk you again Simon 🙂 |
I am on the fence on that one. i like think of the rendered doco as a build output. so for me it make sense that it to be re-rendered on a build. also means if u break doco (eg missing snippet) your build breaks, which i like. |
No description provided.