Ruby Video
Talks
Speakers
Events
Topics
Leaderboard
Sign in
Talks
Speakers
Events
Topics
Use
Analytics
Sign in
Suggest modification to this talk
Title
Description
RubyConf 2018 - The New Design of Ruby's Documentation by ITOYANAGI Sakura Unlike many other languages, Ruby doesn't have great design for documentation. Perl has "perldoc" feature and users easily access documents of modules by "perldoc" command. Python has "docstring" feature and users can access it on REPL. Those are each language's design of importance. The features are not just tool, it contains toolchains and eco-systems. Users of these languages benefit from good documentation design, so library authors write good documentation for them. I'll talk about new Ruby 3's standard documentation design. It pretty improves your development experience.
Date
Summary
Markdown supported
In the video titled "The New Design of Ruby's Documentation" presented at RubyConf 2018 by ITOYANAGI Sakura, the speaker, a documentation maintainer and member of the Ruby core team, discusses the advancements in Ruby's documentation design aimed at enhancing the developer experience. The talk emphasizes the necessity of good documentation as exemplified by other programming languages such as Perl and Python, which have robust documentation tools facilitating user engagement. Key points discussed include: - **Ruby Documentation Improvements**: The speaker highlights the recent improvements in Ruby's documentation, focusing on usability and accessibility enhancements. A structured approach to document modules, classes, methods, and attributes is emphasized to ensure clarity. - **Introduction of New Methods**: A specific mention is made of the 'missing' method in Ruby, which allows for flexible method definitions and execution. - **New Readline Library**: This library provides enhanced user input handling, including line editing and history features, showcasing ease of implementation alongside existing tools like IRB and Pry. A pure Ruby version of the readline library was introduced to aid beginners who might face challenges with installation. - **IRB Enhancements**: Improvements to Ruby's Interactive Ruby Shell (IRB) include enhanced autocomplete functionalities and richer help commands, assisting developers in coding more efficiently. - **Iterative Development Process**: The speaker addresses challenges faced during the development of these new features, such as input representation for non-Unicode encodings and the integration of special characters, reaffirming a commitment to user satisfaction. The conclusion emphasizes the collaborative spirit of the Ruby community and encourages contributions to the ongoing documentation improvement project, highlighting that the enhancements aim to revitalize the overall user experience. Finally, the speaker opens the session for questions, indicating a willingness to engage with the community and receive feedback on the new documentation efforts.
Suggest modifications
Cancel