Fix examples in README.md #310
Open
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
Signed-off-by: Sven Strickroth <[email protected]>
mikesamuel
reviewed
Feb 2, 2024
| @@ -88,25 +88,23 @@ elements do not include any attributes. | |||
| [Attribute policies](https://static.javadoc.io/com.googlecode.owasp-java-html-sanitizer/owasp-java-html-sanitizer/20220608.1/org/owasp/html/AttributePolicy.html) allow running custom code too. Adding an attribute policy will not water down any default policy like `style` or URL attribute checks. | |||
|
|
|||
| ```Java | |||
| new HtmlPolicyBuilder = new HtmlPolicyBuilder() | |||
| PolicyFactory myPolicy = new HtmlPolicyBuilder() | |||
There was a problem hiding this comment.
Maybe HtmlSanitizer.Policy myPolicy = ... and keep the .build() below.
There was a problem hiding this comment.
I made it consistent with the first two examples in README
There was a problem hiding this comment.
Btw. there is no build() method, only build(...) with further parameters...
There was a problem hiding this comment.
Ah. Right. build(...) is when we connect to an output channel and change listener.
There was a problem hiding this comment.
So, what's the status of thie PR?
|
Any news on this? |
|
The readme is still broken... |
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.
There are multiple typos in the README