Skip to content

[mlir][docs] Fix return type in Type/Attr printer docs #101958

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

Merged
merged 1 commit into from
Aug 6, 2024

Conversation

MacDue
Copy link
Member

@MacDue MacDue commented Aug 5, 2024

These return void, not Type or Attribute respectively.

These return `void`, not `Type` or `Attribute` respectively.
@llvmbot llvmbot added the mlir label Aug 5, 2024
@llvmbot
Copy link
Member

llvmbot commented Aug 5, 2024

@llvm/pr-subscribers-mlir

Author: Benjamin Maxwell (MacDue)

Changes

These return void, not Type or Attribute respectively.


Full diff: https://github.com/llvm/llvm-project/pull/101958.diff

1 Files Affected:

  • (modified) mlir/docs/DefiningDialects/AttributesAndTypes.md (+2-2)
diff --git a/mlir/docs/DefiningDialects/AttributesAndTypes.md b/mlir/docs/DefiningDialects/AttributesAndTypes.md
index d6941c0b681f8..1430edd2ffb02 100644
--- a/mlir/docs/DefiningDialects/AttributesAndTypes.md
+++ b/mlir/docs/DefiningDialects/AttributesAndTypes.md
@@ -551,13 +551,13 @@ For Types, these methods will have the form:
 
 - `static Type MyType::parse(AsmParser &parser)`
 
-- `Type MyType::print(AsmPrinter &p) const`
+- `void MyType::print(AsmPrinter &p) const`
 
 For Attributes, these methods will have the form:
 
 - `static Attribute MyAttr::parse(AsmParser &parser, Type attrType)`
 
-- `Attribute MyAttr::print(AsmPrinter &p) const`
+- `void MyAttr::print(AsmPrinter &p) const`
 
 #### Using `assemblyFormat`
 

@MacDue
Copy link
Member Author

MacDue commented Aug 5, 2024

This was a minor error I noticed whilst working on #101850.

Copy link
Collaborator

@joker-eph joker-eph left a comment

Choose a reason for hiding this comment

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

Thanks!

@MacDue MacDue merged commit f57a3a0 into llvm:main Aug 6, 2024
9 checks passed
@MacDue MacDue deleted the correct_doc_return_type branch August 6, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants