[DOC] Clean up doc for File#flock #9332
Conversation
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
file.c
Outdated
| * <td><tt>File::LOCK_NB</tt></td> | ||
| * <td>Non-blocking</td> | ||
| * <td> | ||
| * No blocking; may be combined with other `File::LOCK_SH` or `File::LOCK_EX` |
There was a problem hiding this comment.
The backticks don't work inside of HTML.
| * No blocking; may be combined with other `File::LOCK_SH` or `File::LOCK_EX` | |
| * No blocking; may be combined with other <tt>File::LOCK_SH</tt> or <tt>File::LOCK_EX</tt> |
There was a problem hiding this comment.
@BurdetteLamar this doesn't appear to be fixed.
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
|
@BurdetteLamar there appears to be changes to |
@peterzhu2118, Don't know how to unwind this (attempt failed). Okay to close and put file.c into new PR? |
|
I merged the master branch into this branch, it looks like it solved the issues. |
| * <table> | ||
| * <tr> | ||
| * <th colspan="3">Locking Constants</th> | ||
| * </tr> | ||
| * <tr> | ||
| * <th>Constant</th> | ||
| * <th>Lock</th> | ||
| * <th>Effect</th> | ||
| * </tr> | ||
| * <tr> | ||
| * <td><tt>File::LOCK_EX</tt></td> | ||
| 8000 * <td>Exclusive</td> | ||
| * <td>Only one process may hold an exclusive lock for <tt>self</tt> at a time.</td> | ||
| * </tr> | ||
| * <tr> | ||
| * <td><tt>File::LOCK_NB</tt></td> | ||
| * <td>Non-blocking</td> | ||
| * <td> | ||
| * No blocking; may be combined with other `File::LOCK_SH` or `File::LOCK_EX` | ||
| * using the bitwise OR operator <tt>|</tt>. | ||
| * </td> | ||
| * </tr> | ||
| * <tr> | ||
| * <td><tt>File::LOCK_SH</tt></td> | ||
| * <td>Shared</td> | ||
| * <td>Multiple processes may each hold a shared lock for <tt>self</tt> at the same time.</td> | ||
| * </tr> | ||
| * <tr> | ||
| * <td><tt>File::LOCK_UN</tt></td> | ||
| * <td>Unlock</td> | ||
| * <td>Remove an existing lock held by this process.</td> | ||
| * </tr> | ||
| * </table> |
There was a problem hiding this comment.
This seems duplicate of File::Constants@Locking but different a little.
Why not just linking?
Or a markdown table.
* [Locking Constants](rdoc-ref:File::Constants@Locking)
*
* | Constant | Lock | Effect
* |---------------|--------------|-------------------------------------------------------------------
* | File::LOCK_EX | Exclusive | Only one process may hold an exclusive lock for +self+ at a time.
* | File::LOCK_NB | Non-blocking | No blocking; may be combined with other +File::LOCK_SH+ or +File::LOCK_EX+ using the bitwise OR operator <tt>\|</tt>
* | File::LOCK_SH | Shared | Multiple processes may each hold a shared lock for +self+ at the same time.
* | File::LOCK_UN | Unlock | Remove an existing lock held by this process.
There was a problem hiding this comment.
This seems duplicate of
File::Constants@Lockingbut different a little. Why not just linking?Or a markdown table.
* [Locking Constants](rdoc-ref:File::Constants@Locking) * * | Constant | Lock | Effect * |---------------|--------------|------------------------------------------------------------------- * | File::LOCK_EX | Exclusive | Only one process may hold an exclusive lock for +self+ at a time. * | File::LOCK_NB | Non-blocking | No blocking; may be combined with other +File::LOCK_SH+ or +File::LOCK_EX+ using the bitwise OR operator <tt>\|</tt> * | File::LOCK_SH | Shared | Multiple processes may each hold a shared lock for +self+ at the same time. * | File::LOCK_UN | Unlock | Remove an existing lock held by this process.
@nobu, my aim here is reformatting from RDoc to markdown, not (for the most part) revision; the existing crude "table" has been here at least since before version 2.7.0, so I've retained (but reformatted) it.
I tried the markdown table (Github flavored?), but it did not work for me; do I need to enable something?
There was a problem hiding this comment.
I used the markdown table and it correctly generated a table for me. I'm on RDoc 6.6.2.
There was a problem hiding this comment.
I am running 6,3,1, gem install rdoc failed (problems building native extensions). How to proceed?
There was a problem hiding this comment.
What Ruby are you running and what is the error?
There was a problem hiding this comment.
ruby 3.0.2p107 (2021-07-07 revision 0db68f0) [x86_64-linux-gnu] on my LInux machine.
Over on my Windows machine, I'm running ruby 3,2,2 and rdoc 6.5.0, where the markdown table works fine. Will migrate there and revise.
Switches from RDoc to markdown in order to have a better table.