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.

Sign up for GitHub

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

Jump to bottom

Address markdownlint issues #460

Merged
merged 3 commits into from
Aug 1, 2022
Merged

Address markdownlint issues #460

merged 3 commits into from
Aug 1, 2022

Conversation

samet-akcay
Copy link
Contributor

Description

  • This PR adds markdownlint to the repo and addressed all the issues raised by the tool

Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • My code follows the pre-commit style and check guidelines of this project.
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes

ashwinvaidya17
ashwinvaidya17 reviewed Jul 29, 2022
View reviewed changes
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! I have two comments.

anomalib/models/dfm/README.md Outdated Show resolved Hide resolved
tools/benchmarking/README.md Outdated Show resolved Hide resolved
djdameln
djdameln reviewed Jul 29, 2022
View reviewed changes
Copy link
Contributor

@djdameln djdameln left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! minor stuff

.github/pull_request_template.md Show resolved Hide resolved
.pre-commit-config.yaml Show resolved Hide resolved
anomalib/models/dfm/README.md Outdated Show resolved Hide resolved
@samet-akcay samet-akcay requested a review from djdameln August 1, 2022 04:17
ashwinvaidya17
ashwinvaidya17 reviewed Aug 1, 2022
View reviewed changes
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be something wrong with the configuration

.github/ISSUE_TEMPLATE/bug_report.md Show resolved Hide resolved
docs/source/guides/structure_of_documentation.md Show resolved Hide resolved
docs/source/guides/using_tox.md Show resolved Hide resolved
ashwinvaidya17
ashwinvaidya17 approved these changes Aug 1, 2022
View reviewed changes
Copy link
Collaborator

@ashwinvaidya17 ashwinvaidya17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing this! Will you be adding the badge to this PR or to a new one?

@samet-akcay samet-akcay merged commit 33355be into development Aug 1, 2022
@samet-akcay samet-akcay deleted the docs/markdownlint branch August 1, 2022 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ashwinvaidya17 ashwinvaidya17 ashwinvaidya17 approved these changes

@djdameln djdameln Awaiting requested review from djdameln

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@samet-akcay @ashwinvaidya17 @djdameln