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

Fix doc formatting written in unescaped file path #1247

Closed
wants to merge 1 commit into from

Conversation

ydah
Copy link
Member

@ydah ydah commented Mar 7, 2022

This fixes an issue where file paths were not escaped and were displayed as follows:
issue


Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
    • [-] Added tests.
  • Updated documentation.
    • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
    • [-] The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@ydah ydah marked this pull request as draft March 7, 2022 09:58
@ydah
Copy link
Member Author

ydah commented Mar 7, 2022

This PR is closed as it will be resolved by rubocop/rubocop#10444

Because the rubocop/cops_documentation_generator is used below.

@ydah ydah closed this Mar 7, 2022
@ydah ydah deleted the fix-doc-formatting branch March 7, 2022 12:13
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.

None yet

1 participant