Closed
Conversation
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email support@ekline.io. |
There was a problem hiding this comment.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
| @@ -266,6 +266,8 @@ The `followRedirects` option controls how Linkspector handles HTTP redirects (e. | |||
| - When `followRedirects: false`: | |||
| Linkspector will _not_ follow HTTP redirects. If a link returns a redirect status code (e.g., 301, 302, 307, 308), it will be reported as an 'error'. The reported status code will be the original redirect status code (e.g., 301), and the error message will indicate that the link redirected but `followRedirects` was set to `false`. | |||
There was a problem hiding this comment.
🚫 [EkLine] <EK00005>
Suggestions:
- Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
- Prefer English terms over Latin abbreviations. Use 'for example' instead of 'e.g.'. (EK00026)
- In general, use active voice instead of passive voice ('be reported'). (EK00031)
- In general, use active voice instead of passive voice ('was set'). (EK00031)
Suggested change
| Linkspector will _not_ follow HTTP redirects. If a link returns a redirect status code (e.g., 301, 302, 307, 308), it will be reported as an 'error'. The reported status code will be the original redirect status code (e.g., 301), and the error message will indicate that the link redirected but `followRedirects` was set to `false`. | |
| Linkspector will _not_ follow HTTP redirects. If a link returns a redirect status code (for example, 301, 302, 307, 308), it will be reported as an 'error'. The reported status code will be the original redirect status code (for example, 301), and the error message will indicate that the link redirected but `followRedirects` was set to `false`. |
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
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.
Description
Please include a summary of the change and which issue is fixed. Also include relevant motivation and context. List any dependencies that are required for this change. Delete any other sections or text that are not relevant.
Fixes # (issue number)
Type of Change
Please delete options that are not relevant.
Checklist:
Additional Information
Include any additional information about the pull request here.