Page MenuHomePhabricator

Fix emitting attribute documentation
ClosedPublic

Authored by marbre on Tue, Feb 23, 2:36 AM.

Details

Summary

This fixes the documentation emitted for type parameters. Also adds a
missing empty line, rendered as line break in mark down.

Co-authored-by: Simon Camphausen <simon.camphausen@iml.fraunhofer.de>

Diff Detail

Event Timeline

marbre created this revision.Tue, Feb 23, 2:36 AM
marbre requested review of this revision.Tue, Feb 23, 2:36 AM

Can you show an example of before/after?

Can you show an example of before/after?

Sure! For EmitC.md, the resulting doc would change as in the following patch:

--- ../docs/EmitC.md    2021-02-17 09:18:41.760151054 +0100
+++ docs/Dialects/EmitC.md      2021-02-23 09:05:03.999213035 +0100
@@ -233,11 +233,12 @@ yielded.
 ### `OpaqueType` (OpaqueType)
 
 An opaque type
+
 An opaque data type of which the value gets emitted as is.
 
 #### Type parameters:
 
 | Parameter | C++ type | Description |
 | :-------: | :-------: | ----------- |
-| value | `OpaqueType` | the opaque value |
+| value | `::llvm::StringRef` | the opaque value |
rriddle accepted this revision.Tue, Feb 23, 2:45 AM

Nice, that looks much better.

This revision is now accepted and ready to land.Tue, Feb 23, 2:45 AM
This revision was automatically updated to reflect the committed changes.