[ruby-core:123569] [Ruby Bug#21652] Marshal#dump documentation out-of-date/unclear regarding Data class
Issue #21652 has been reported by ryannevell (Ryan Nevell). ---------------------------------------- Bug #21652: Marshal#dump documentation out-of-date/unclear regarding Data class https://bugs.ruby-lang.org/issues/21652 * Author: ryannevell (Ryan Nevell) * Status: Open * ruby -v: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux] * Backport: 3.2: UNKNOWN, 3.3: UNKNOWN, 3.4: UNKNOWN ---------------------------------------- With the introduction of the `Data` class in Ruby 3.2, the `Marshal#dump` documentation is confusing since it claims that "Marshal can’t dump ... an instance of ... Data". It is even cross-linked to the new `Data` class. However, and thankfully, `Marshal#dump` does not have any issues serializing instances of `Data` or objects of the defined `Data` types. This message predates the introduction of the `Data` class, and likely refers to wrapped C data (`T_DATA`), instead. -- https://bugs.ruby-lang.org/
Issue #21652 has been updated by alanwu (Alan Wu). Backport changed from 3.2: REQUIRED, 3.3: REQUIRED, 3.4: REQUIRED to 3.2: REQUIRED, 3.3: REQUIRED, 3.4: DONE ruby_3_4 commit:badb3600093ed5df2c64bc257b5cb3a149a88189 ---------------------------------------- Bug #21652: Marshal#dump documentation out-of-date/unclear regarding Data class https://bugs.ruby-lang.org/issues/21652#change-115113 * Author: ryannevell (Ryan Nevell) * Status: Closed * ruby -v: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux] * Backport: 3.2: REQUIRED, 3.3: REQUIRED, 3.4: DONE ---------------------------------------- With the introduction of the `Data` class in Ruby 3.2, the `Marshal#dump` documentation is confusing since it claims that "Marshal can’t dump ... an instance of ... Data". It is even cross-linked to the new `Data` class. However, and thankfully, `Marshal#dump` does not have any issues serializing instances of `Data` or objects of the defined `Data` types. This message predates the introduction of the `Data` class, and likely refers to wrapped C data (`T_DATA`), instead. -- https://bugs.ruby-lang.org/
Issue #21652 has been updated by nagachika (Tomoyuki Chikanaga). Backport changed from 3.2: REQUIRED, 3.3: REQUIRED, 3.4: DONE to 3.2: REQUIRED, 3.3: DONE, 3.4: DONE ruby_3_3 commit:278b731ab92608e75d882036a71eb5825631ef69 merged revision(s) commit:d17ce4bd05dc05d48f5f4bc75171fcebda1678ed. ---------------------------------------- Bug #21652: Marshal#dump documentation out-of-date/unclear regarding Data class https://bugs.ruby-lang.org/issues/21652#change-115353 * Author: ryannevell (Ryan Nevell) * Status: Closed * ruby -v: ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux] * Backport: 3.2: REQUIRED, 3.3: DONE, 3.4: DONE ---------------------------------------- With the introduction of the `Data` class in Ruby 3.2, the `Marshal#dump` documentation is confusing since it claims that "Marshal can’t dump ... an instance of ... Data". It is even cross-linked to the new `Data` class. However, and thankfully, `Marshal#dump` does not have any issues serializing instances of `Data` or objects of the defined `Data` types. This message predates the introduction of the `Data` class, and likely refers to wrapped C data (`T_DATA`), instead. -- https://bugs.ruby-lang.org/
participants (3)
-
alanwu (Alan Wu) -
nagachika (Tomoyuki Chikanaga) -
ryannevell (Ryan Nevell)