<table border="1" cellspacing="0" cellpadding="8">
<tr>
<th>Issue</th>
<td>
<a href=https://github.com/llvm/llvm-project/issues/112672>112672</a>
</td>
</tr>
<tr>
<th>Summary</th>
<td>
[mlir][doc] Adds a `\n` if description string not end with `\n`.
</td>
</tr>
<tr>
<th>Labels</th>
<td>
mlir
</td>
</tr>
<tr>
<th>Assignees</th>
<td>
</td>
</tr>
<tr>
<th>Reporter</th>
<td>
CoTinker
</td>
</tr>
</table>
<pre>
The `mlir-linalg-ods-yaml-gen` tool converts description to a single-line string in tblgen file.
For example:
```yaml
metadata: !LinalgOpMetadata
name: abs
cpp_class_name: AbsOp
doc: |-
Applies abs(x) elementwise.
No numeric casting is performed on the input operand.
```
is converted to
```tblgen
let description = [{No numeric casting is performed on the input operand.}];
```
In this case, the string of description is `"No numeric casting is performed on the input operand."`, without a trailing newline(`\n`). This causes the `Traits` section to appear on the same line as the end of description in the generated markdown, as seen here https://mlir.llvm.org/docs/Dialects/Linalg/#linalgabs-linalgabsop.
![image](https://github.com/user-attachments/assets/db1d17af-c770-4d43-b6d9-49f3dc226659)
Generially, we define `description` as a multi-line string in tblgen. Such as:
```tblgen
let description = [{
No numeric casting is performed on the input operand.
}];
```
In this case, the string becomes `"\n No numeric casting is performed on the input operand.\n"`, end with `\n`, which ensures that `Traits` starts on a new line after the description.
To fix this, we should append a newline (`\n`) if the description string doesn’t already end with one.
</pre>
<img width="1px" height="1px" alt="" src="http://email.email.llvm.org/o/eJykVU2PpDYQ_TXuS4kWGGi6Dxx6utNRpCR7yNxXhV2As8ZGttnZ-feRzTBfO4qiiTTS0EVV-dWr9zB6rwZD1LL6jtXXHS5htK692HtlvpHbdVY-tvcjATvkk1Yu08qgHjIrffaIk84GMuyQQ7BWg7DmO7ngQZIXTs1BWQPBAoJXZtAUiwl8cMoMoAyETg9koFea9iy_svx8sw7oB06zJlae1xg75OtfPG8NTRRQYkBWnoHx4veE6cv8xxZOSQAGp9gGsPNbSMzzV6HR-6_by3Pnv8zba2lF6tlcsi0EcJ5nrcinNvz4g_ETkKaJTHhQfkP-kv6nBbNM5JQAgT6kWT3M5HrrJpIQORkJlJmXAHYmh0bu3426_lR-o5QkBPsuZ2VvDWoKb0hn5RXiRpu7z6Fprqy-svLuQ1i_xZKIDT0xfkn1T0u1_RsYykfdMM4_h4LzVH2BBxVGuwRACA6VjuWGHqKaGD_GnPpiUuppD_crtMWTTz0jgnuHKvioU0_iWZXzTOi2oz1OBEmfuNaRkT-Ns6YOZMhh3MmE7pu0DyZiRA-eyMBIjgDGEGYfJcxvjN-ic_Zaf5_21g2M36QVnvHbVaEmEeLjKuGUXa4Ww85nz0923hTCC1bfqQkHihvix7cHDSqMS7cXdmL8tnhyGYaAYoxijceg95QeZFfIosE-E02TZ5Wsyqw7yFNWnfpSCs4Ph_rE-Om1tn-NYyvU-jGthEBSH_lih_wVSZFk9IAwLTqojx2_h78WMQL6nz3-30S9me3_WO2zEu9I2Ik2YUflfRZHFO2zxKPcoszhtZwv8DAqMQIZv7ikZwzv9BwwfnCtAYyWeFJwH8ilE1_R9-Y7dW-hVz_SjE_L9KNdtEymMHJtlnq9Nxio_n3njRlpyRv2C2fHnJ1OAVA7Qvn4Mpo1tN_JtpSn8oQ7aouGn4q6KHmzG9tDVWEnBAl-lCTwWBPJQ84Lkcu-LKp6p1qe86rIiyZvqmPV7IuSRNFJarqi6jusWJXThEo_O22nvF-oLQp-aPhOY0fap4uO8-jItL7rzrUxP-uWwbMq18oH_9IhqKDT5ZgK6iur7-IdUV_hLGWU-Qs5kZkPWDE2fLTc_W5xuv0X90YIT_-y2dm_SQTGb2miaOCnob63_J8AAAD__92ieAY">