This is an archive of the discontinued LLVM Phabricator instance.

[MLIR] Improving the Comment
ClosedPublic

Authored by kamleshbhalui on Aug 29 2020, 10:51 PM.

Details

Summary

Fixed the misleading comment.
i.e.
Returns if ...
to
Returns true if ...

Diff Detail

Event Timeline

kamleshbhalui created this revision.Aug 29 2020, 10:51 PM
kamleshbhalui requested review of this revision.Aug 29 2020, 10:51 PM
bondhugula accepted this revision.Aug 29 2020, 11:35 PM
bondhugula added a subscriber: bondhugula.

Please fix the 80 column spillovers. Although this "Returns if ..." construction is used pervasively and isn't actually incorrect, it can be a bit confusing. "if this ..." was being used as a noun for the bool value.

Please fix the commit title - it's itself broken.
Improve the Comment -> "Improve doc comments for several methods returning bools"

mlir/include/mlir/Dialect/Affine/IR/AffineOps.h
375

This will have to be wrapped.

This revision is now accepted and ready to land.Aug 29 2020, 11:35 PM
This revision was landed with ongoing or failed builds.Aug 30 2020, 1:03 AM
This revision was automatically updated to reflect the committed changes.