Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HTML fragments in ri output #1138

Open
zenspider opened this issue Jul 10, 2024 · 2 comments
Open

HTML fragments in ri output #1138

zenspider opened this issue Jul 10, 2024 · 2 comments

Comments

@zenspider
Copy link
Member

This happens on 3.3.3 and 3.3.4. Dunno when it started but HTML needs to be removed from ri output.

10007 $ ri File.flock
= File.flock

(from ruby core)
------------------------------------------------------------------------
  flock(locking_constant) -> 0 or false

------------------------------------------------------------------------

Locks or unlocks a file according to the given locking_constant,
a bitwise OR of the values in the table below.
Not available on all platforms.
Returns false if File::LOCK_NB is specified and the operation would have
blocked;
otherwise returns 0.
<table>
  <tr>
    <th colspan="3">Locking Constants</th>
  </tr>
  <tr>

I can see this in file.c:

/*  :markup: markdown                                                           
...
 *  | Constant        | Lock         | Effect                                   
 *  |-----------------|--------------|-----------------------------------------\
...
 */
@flavorjones
Copy link
Contributor

@zenspider The HTML snippet you're seeing looks like it was added directly to the RBS doc string as HTML in ruby/rbs@c8151a59. RDoc isn't doing anything except using the raw string provided by the gem. I think the right place to file this issue is in ruby/rbs?

@colby-swandale
Copy link
Member

Hello @soutaro 👋🏻 (long time no see!). I read this issue and thought you perhaps be able to provide some insight into this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants