From: "laurent_martin (Laurent Martin) via ruby-core" <ruby-core@...>
Date: 2022-12-31T12:03:21+00:00
Subject: [ruby-core:111552] [Ruby master Bug#19290] Documentation: "produces:" (introducing terminal output) is wrongly formatted in few places

Issue #19290 has been updated by laurent_martin (Laurent Martin).


## `gc.c`

problem: formating not consistent with other source files:

source: https://github.com/ruby/ruby/blob/master/gc.c#L14423

Fix:

```
 *  _produces:_
```

replaced with:

```
 *  <em>produces:</em>
```


----------------------------------------
Bug #19290: Documentation: "produces:" (introducing terminal output) is wrongly formatted in few places
https://bugs.ruby-lang.org/issues/19290#change-100915

* Author: laurent_martin (Laurent Martin)
* Status: Open
* Priority: Normal
* ruby -v: 3.3.0dev
* Backport: 2.7: UNKNOWN, 3.0: UNKNOWN, 3.1: UNKNOWN, 3.2: UNKNOWN
----------------------------------------
## `warning.rb`

Problem: The text "produces:" is embedded in formatted text, it should be normal emphasized text.

view here: https://ruby-doc.org/3.2.0/Kernel.html , 2 times after: "If warnings have been disabled"

source:

https://github.com/ruby/ruby/blob/master/warning.rb#L18

https://github.com/ruby/ruby/blob/master/warning.rb#L38

Fix: in both cases, remove one space character just before `<em>produces:</em>`

```
  #  <em>produces:</em>
```

shall be:

```
  # <em>produces:</em>
```

## `signal.c`

Problem: the text "produces:" is not emphasized like others.

view here: https://ruby-doc.org/3.2.0/Kernel.html after: "special signal name"
view here: https://ruby-doc.org/3.2.0/Signal.html

source:

https://github.com/ruby/ruby/blob/master/signal.c#L1386

https://github.com/ruby/ruby/blob/master/signal.c#L1538

Fix: surround with `<em>` and `</em>`, and add a line after the line: (2 places)

```
* produces:
```

shall be:

```
* <em>produces:</em>
*
```




-- 
https://bugs.ruby-lang.org/
 ______________________________________________
 ruby-core mailing list -- ruby-core@ml.ruby-lang.org
 To unsubscribe send an email to ruby-core-leave@ml.ruby-lang.org
 ruby-core info -- https://ml.ruby-lang.org/mailman3/postorius/lists/ruby-core.ml.ruby-lang.org/