Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the API documentation for various classes and modules, including Addrinfo, ArgumentError, Enumerator, and File. The changes involve updating YARD versions, simplifying inheritance hierarchies, and modifying constant and attribute summaries. I have provided feedback regarding the potential loss of navigability due to removed links and truncated constant lists, as well as a request to verify the new keyword argument structure in the Enumerator constructor.
| <h3 class="signature first" id="initialize-instance_method"> | ||
|
|
||
| #<strong>initialize</strong>(obj, method = :each, *args) ⇒ <tt><span class='object_link'><a href="" title="Enumerator (class)">Enumerator</a></span></tt> | ||
| #<strong>initialize</strong>(obj, method = :each, *args, **kwd) ⇒ <tt><span class='object_link'><a href="" title="Enumerator (class)">Enumerator</a></span></tt> |
There was a problem hiding this comment.
The constructor signature for Enumerator now includes **kwd. Ensure that this change is reflected in the documentation and that all callers are updated to handle the new keyword argument structure.
| <dd>mrbgems/mruby-socket/src/socket.c<span class="defines">,<br /> | ||
| mrbgems/mruby-socket/mrblib/socket.rb</span> | ||
| </dd> | ||
| <dd>mrbgems/mruby-socket/mrblib/socket.rb</dd> |
There was a problem hiding this comment.
The removal of the source file reference from the documentation might make it harder for developers to locate the source code definition. If this was intentional, ensure that the documentation still provides sufficient context for the user.
| <dt>Inherits:</dt> | ||
| <dd> | ||
| <span class="inheritName"><span class='object_link'><a href="StandardError.html" title="StandardError (class)">StandardError</a></span></span> | ||
| <span class="inheritName">StandardError</span> |
There was a problem hiding this comment.
The inheritance hierarchy in the documentation has been simplified by removing links to parent classes. This reduces navigability for users trying to understand the class structure. Consider restoring the links to StandardError and Exception.
| @@ -133,11 +132,6 @@ <h3 class="inherited">Constants included | |||
|
|
|||
There was a problem hiding this comment.
The instance attribute summary for Lazy has been removed. If these attributes are still part of the public API, they should be documented.
| <h3 class="inherited">Constants included | ||
| from <span class='object_link'><a href="File/Constants.html" title="File::Constants (module)">Constants</a></span></h3> | ||
| <p class="inherited"><span class='object_link'><a href="File/Constants.html#APPEND-constant" title="File::Constants::APPEND (constant)">Constants::APPEND</a></span>, <span class='object_link'><a href="File/Constants.html#BINARY-constant" title="File::Constants::BINARY (constant)">Constants::BINARY</a></span>, <span class='object_link'><a href="File/Constants.html#CREAT-constant" title="File::Constants::CREAT (constant)">Constants::CREAT</a></span>, <span class='object_link'><a href="File/Constants.html#DSYNC-constant" title="File::Constants::DSYNC (constant)">Constants::DSYNC</a></span>, <span class='object_link'><a href="File/Constants.html#EXCL-constant" title="File::Constants::EXCL (constant)">Constants::EXCL</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_CASEFOLD-constant" title="File::Constants::FNM_CASEFOLD (constant)">Constants::FNM_CASEFOLD</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_DOTMATCH-constant" title="File::Constants::FNM_DOTMATCH (constant)">Constants::FNM_DOTMATCH</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_NOESCAPE-constant" title="File::Constants::FNM_NOESCAPE (constant)">Constants::FNM_NOESCAPE</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_PATHNAME-constant" title="File::Constants::FNM_PATHNAME (constant)">Constants::FNM_PATHNAME</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_SYSCASE-constant" title="File::Constants::FNM_SYSCASE (constant)">Constants::FNM_SYSCASE</a></span>, <span class='object_link'><a href="File/Constants.html#NOCTTY-constant" title="File::Constants::NOCTTY (constant)">Constants::NOCTTY</a></span>, <span class='object_link'><a href="File/Constants.html#NOFOLLOW-constant" title="File::Constants::NOFOLLOW (constant)">Constants::NOFOLLOW</a></span>, <span class='object_link'><a href="File/Constants.html#NONBLOCK-constant" title="File::Constants::NONBLOCK (constant)">Constants::NONBLOCK</a></span>, <span class='object_link'><a href="File/Constants.html#RDONLY-constant" title="File::Constants::RDONLY (constant)">Constants::RDONLY</a></span>, <span class='object_link'><a href="File/Constants.html#RDWR-constant" title="File::Constants::RDWR (constant)">Constants::RDWR</a></span>, <span class='object_link'><a href="File/Constants.html#SYNC-constant" title="File::Constants::SYNC (constant)">Constants::SYNC</a></span>, <span class='object_link'><a href="File/Constants.html#TRUNC-constant" title="File::Constants::TRUNC (constant)">Constants::TRUNC</a></span>, <span class='object_link'><a href="File/Constants.html#WRONLY-constant" title="File::Constants::WRONLY (constant)">Constants::WRONLY</a></span></p> | ||
|
|
||
|
|
||
|
|
||
| <h3 class="inherited">Constants inherited | ||
| from <span class='object_link'><a href="IO.html" title="IO (class)">IO</a></span></h3> | ||
| <p class="inherited"><span class='object_link'><a href="IO.html#BUF_SIZE-constant" title="IO::BUF_SIZE (constant)">IO::BUF_SIZE</a></span>, <span class='object_link'><a href="IO.html#SEEK_CUR-constant" title="IO::SEEK_CUR (constant)">IO::SEEK_CUR</a></span>, <span class='object_link'><a href="IO.html#SEEK_END-constant" title="IO::SEEK_END (constant)">IO::SEEK_END</a></span>, <span class='object_link'><a href="IO.html#SEEK_SET-constant" title="IO::SEEK_SET (constant)">IO::SEEK_SET</a></span></p> | ||
| <p class="inherited"><span class='object_link'><a href="File/Constants.html#FNM_CASEFOLD-constant" title="File::Constants::FNM_CASEFOLD (constant)">Constants::FNM_CASEFOLD</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_DOTMATCH-constant" title="File::Constants::FNM_DOTMATCH (constant)">Constants::FNM_DOTMATCH</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_NOESCAPE-constant" title="File::Constants::FNM_NOESCAPE (constant)">Constants::FNM_NOESCAPE</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_PATHNAME-constant" title="File::Constants::FNM_PATHNAME (constant)">Constants::FNM_PATHNAME</a></span>, <span class='object_link'><a href="File/Constants.html#FNM_SYSCASE-constant" title="File::Constants::FNM_SYSCASE (constant)">Constants::FNM_SYSCASE</a></span></p> |
There was a problem hiding this comment.
The constant list for File::Constants has been significantly truncated. Ensure that all relevant constants are still accessible and documented for users of the File class.
2 participants
fixes #231
ℹ️ regenerated using 3.4.0 mruby git tag