Skip to content
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

Adding documentation to RazorEngineCompilationOptionsBuilder #140

Merged
merged 2 commits into from
Feb 23, 2024
Merged

Adding documentation to RazorEngineCompilationOptionsBuilder #140

merged 2 commits into from
Feb 23, 2024

Conversation

MichaelCleverdon
Copy link

@MichaelCleverdon MichaelCleverdon commented Feb 22, 2024

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!

@MichaelCleverdon MichaelCleverdon changed the title mcleverdon Adding documentation to RazorEngineCompilationOptionsBuilder Adding documentation to RazorEngineCompilationOptionsBuilder Feb 22, 2024
@adoconnection
Copy link
Owner

Hi, Michael! Documentation is warmly welcome 🔥 Thanks!

@adoconnection adoconnection merged commit 6045d53 into adoconnection:master Feb 23, 2024
@MichaelCleverdon MichaelCleverdon deleted the Documentation branch February 26, 2024 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants