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

[docs] Refresh add_ops.md #3939

Merged
merged 12 commits into from
Jan 8, 2025
Merged

Conversation

bjacobgordon
Copy link
Contributor

@bjacobgordon bjacobgordon commented Jan 3, 2025

  • removes section regarding Turbine Camp
    • Each line of detail either:
      • already existed internally in Confluence
        OR
      • was severely out of date!
    • Was beyond the concerns of Torch-MLIR
  • adjusts link to LLVM style guide
    • was directed to a specific style guide rule rather than the start of the style guide in general
  • adds missing h2
  • cleans up style using markdown linter
    • prefers formatted links over intentionally bare URLs
    • enforces explicitly-define language in code blocks
    • prefers implicitly-ordered, 1-based lists
      • avoids less-common 0-based lists since that would require deviation from the default linter config
    • wraps bare urls/emails
    • enforces unordered list nested indentation
    • enforces space around headers
    • enforces space around code fence blocks
    • removes extraneous blank lines
    • enforces space around list blocks

@bjacobgordon bjacobgordon force-pushed the docs-refreshes-add-ops-md branch from 39a20d5 to e3eb6c6 Compare January 3, 2025 21:15
@bjacobgordon
Copy link
Contributor Author

bjacobgordon commented Jan 3, 2025

Cleaned up this doc while going through Turbine Camp!
 
Commits are "atomic" as follows:

  • style commits are pure linting
  • one is minor structural
  • final one is the crux of the PR

It'll probably be quicker to review each one individually!

@marbre I think this'll be an easy one! Could you review it?

@bjacobgordon bjacobgordon marked this pull request as ready for review January 3, 2025 21:18
@bjacobgordon bjacobgordon force-pushed the docs-refreshes-add-ops-md branch from e3eb6c6 to 2135d7e Compare January 3, 2025 21:21
@marbre marbre self-requested a review January 3, 2025 21:45
Copy link
Member

@marbre marbre 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 going over this. Some first comments.

docs/add_ops.md Outdated Show resolved Hide resolved
docs/add_ops.md Outdated Show resolved Hide resolved
docs/add_ops.md Outdated Show resolved Hide resolved
docs/add_ops.md Outdated Show resolved Hide resolved
@bjacobgordon bjacobgordon force-pushed the docs-refreshes-add-ops-md branch 3 times, most recently from 50f1905 to 2bff98d Compare January 6, 2025 22:23
- addresses issues mentioned by markdown linter
- avoids less-common 0-based lists since that would require deviation from the default linter config
…locks

- addresses issues mentioned by markdown linter
- Each line of detail either:
  - already existed internally in [Confluence](https://confluence.amd.com/display/SHARK/Turbine+Camp)
    OR
  - was severely out of date!
- Was beyond the concerns of Torch-MLIR
- was directed to a specific style guide rule rather than the start of the style guide in general
@bjacobgordon bjacobgordon force-pushed the docs-refreshes-add-ops-md branch from 2bff98d to 87da8ed Compare January 7, 2025 15:26
@bjacobgordon bjacobgordon changed the title [docs] Refreshes add_ops.md [docs] refreshes add_ops.md Jan 7, 2025
@bjacobgordon bjacobgordon changed the title [docs] refreshes add_ops.md [docs] Refreshes add_ops.md Jan 8, 2025
@bjacobgordon bjacobgordon changed the title [docs] Refreshes add_ops.md [docs] Refresh add_ops.md Jan 8, 2025
@marbre marbre merged commit f92c587 into llvm:main Jan 8, 2025
3 checks passed
@bjacobgordon bjacobgordon deleted the docs-refreshes-add-ops-md branch January 8, 2025 22:59
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.

2 participants