adoconnection / RazorEngineCore

.NET6 Razor Template Engine
MIT License
576 stars 85 forks source link

Adding documentation to RazorEngineCompilationOptionsBuilder #140

Closed MichaelCleverdon closed 7 months ago

MichaelCleverdon commented 7 months ago

Hi! I was recently working with your library, and found some difficulty in debugging my integration with it because of a lack of understanding around when I should be using AddUsing() vs AddReferenceByName(). I eventually got everything good to go, but that was only after digging into the repo to understand what each method did under the hood. I understand not wanting to display everything that goes on under the hood, but I wanted to add some documentation on what each of the different method did in the builder options area. That way people don't need to dig into the repo if they have a simple use case, but aren't aware of how to implement it properly

If you're wanting to see how the comments look, pulling down the branch and hovering over the method should show the method comments image

If you have verbiage recommendations, I would love to hear them

Thanks!

adoconnection commented 7 months ago

Hi, Michael! Documentation is warmly welcome 🔥 Thanks!