triple-buffer icon indicating copy to clipboard operation
triple-buffer copied to clipboard

Consider flipping peek_output_buffer() naming convention in next major release

Open HadrienG2 opened this issue 1 year ago • 2 comments

As discussed in #28 , in an ideal world, peek_output_buffer() would be called output_buffer(), and output_buffer() would be called output_buffer_mut(). And the input_buffer() API would work similarly. But that's a breaking API change, so ideally it would be done gradually.

  • [x] First, publish a minor release that adds input_buffer_mut() and output_buffer_mut() methods and throws a deprecation warning when calling input_buffer() or output_buffer() (which are now aliases to these methods), with a warning that their semantics are going to change to read-only in the future.
  • [x] Next, a few months to a year later, publish a major release which changes input_buffer() and output_buffer() to read-only access, removes the deprecation warning, and deprecates the peek_output_buffer() method.
  • [ ] Finally, a few months to a year later, publish another major release which removes the peek_output_buffer() method.

HadrienG2 avatar Jun 21 '24 12:06 HadrienG2