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

Explain IR acronym in README #7506

Merged
merged 2 commits into from
Aug 12, 2024
Merged

Explain IR acronym in README #7506

merged 2 commits into from
Aug 12, 2024

Conversation

parker-research
Copy link
Contributor

@parker-research parker-research commented Aug 10, 2024

Fixes #7323. Change is pre-approved.

README.md Outdated
@@ -5,7 +5,7 @@

# ⚡️ "CIRCT" / Circuit IR Compilers and Tools

"CIRCT" stands for "Circuit IR Compilers and Tools". One might also interpret
"CIRCT" stands for "Circuit Intermediate Representation (IR) Compilers and Tools". One might also interpret
Copy link
Member

Choose a reason for hiding this comment

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

I think we need to discuss whether in the title this refers to Intermediate Representation or Intermediate Representations. I personally opt for the plural form as the various dialects function more as a set of inter-operable IRs rather than a single IR.

Suggested change
"CIRCT" stands for "Circuit Intermediate Representation (IR) Compilers and Tools". One might also interpret
"CIRCT" stands for "Circuit Intermediate Representations (IR) Compilers and Tools". One might also interpret

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will wait for one more person to agree before I make the change, unless you think I should just do it now!

I personally prefer singular, but am not very familiar with this project

Copy link
Member

@dobios dobios Aug 12, 2024

Choose a reason for hiding this comment

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

It also makes sense because the rest of the title is in plural form as well. Also as I explained there is more than one IR in the project and the issue you mentioned wasn't an answer to "what does IR refer to in the title" but rather "what does IR mean in general", which is a very commonly used acronym in the field. So I definitely think that it should be plural.

@parker-research
Copy link
Contributor Author

Pluralized!

@dobios dobios merged commit b9c202e into llvm:main Aug 12, 2024
4 checks passed
@parker-research parker-research deleted the readme-1 branch August 12, 2024 22:36
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.

[README] what does "IR" stand for?
2 participants