Doc fixes #606
Merged
Doc fixes #606
Conversation
This file contains hidden or 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
- Fix links to NSubstitute.Analyzers docs in "How NSubstitute Works" doc. - For nsubstitute#599, the docs are referring to real code executing for non-overridable members, which includes `protected virtual` code, even if these calls are not (easily) configurable via the NSubstitute API. Have attempted to clarify by: + updating "Getting Started" to not give specifics, and just link to more info in "Creating a sub" so this information is centralised and consistent. Also adds more advice to install Analyzers. + update "Creating a sub" to mention configuration can only be via callable API.
| @@ -15,7 +15,7 @@ This is how you'll normally create substitutes for types. Generally this type wi | |||
|
|
|||
| ⚠️ **Warning:** Substituting for classes can have some nasty side-effects! | |||
|
|
|||
| For starters, **NSubstitute can only work with *virtual* members of the class** that are overridable in the test assembly, so any non-virtual code in the class will actually execute! If you try to substitute for a class that formats your hard drive in the constructor or in a non-virtual property setter then you're asking for trouble. (By overridable we mean `public virtual`, `protected virtual`, `protected internal virtual`, or `internal virtual` with `InternalsVisibleTo` attribute applied. See [How NSubstitute works](/help/how-nsub-works) for more information.) | |||
There was a problem hiding this comment.
This still has protected virtual in the doc. I thought we wanted to remove it. Am I missing something?
There was a problem hiding this comment.
I admit this is confusing. These docs are referring to real code executing for non-overridable members, which includes protected virtual code, even if these calls are not (easily) configurable via the NSubstitute API. It's not about what methods we can configure with NSub -- it's about what real code can execute.
There is probably a better way to communicate this. 🤔
dtchepak
added a commit
to nsubstitute/nsubstitute.github.com
that referenced
this pull request
Mar 4, 2020
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.
non-overridable members, which includes
protected virtualcode, evenif these calls are not (easily) configurable via the NSubstitute API.
Have attempted to clarify by:
more info in "Creating a sub" so this information is centralised and
consistent. Also adds more advice to install Analyzers.
callable API.
@alexandrnikitin or @zvirja, can one of you please take a quick proof-read and make sure this makes sense?