yard
yard copied to clipboard
lsegal
YARD is a Ruby Documentation tool. The Y stands for "Yay!"
# Description This PR removes a (1) file from the gemspec's `files` directive. With default settings, a consuming project could inadvertently end up including the directives set up for the...
I'm currently digging into [CVE-2019-1020001](https://nvd.nist.gov/vuln/detail/CVE-2019-1020001) that was assigned to the `yard` security advisory [GHSA-xfhh-rx56-rxcr](https://github.com/lsegal/yard/security/advisories/GHSA-xfhh-rx56-rxcr). Unfortunately I'm unable to identify the commit that can be connected to this arbitrary path traversal...
It appear that when I run `yard stats --list-undoc` the generated HTML output is also updated, like when I run `yard doc`. Is this something that can be relied on?...
# Description This PR aims to fix an issue with how yard handles syntax highlighted snippets from `{include:file:...}` source. When an included file contains code blocks, they'll be fed through...
# Description This implements the fix suggested by @akimd [here](https://github.com/lsegal/yard/issues/1434#issuecomment-1087817139): > I believe the proper fix is in lib/yard/parser/ruby/ast_node.rb to replace: > > ```ruby > def line > line_range &&...
# Description This reverts commit a80a728af430b9b316e20221d69a21db4780af75. 'revisit when fixed' Fixed by PR #1385 # Completed Tasks - [x] I have read the [Contributing Guide][contrib]. - [x] The pull request is...
This is best shown with a real life example using a default attribute reader along with an explicit attribute writer which should be [documented with overloads as per your comment...
Yards AST parser raises `cannot get the first element of beginless range (RangeError)` when using right-hand assignment and restructuring. I have tried using restructuring in different contexts and only the...
Create the following file `foo.rb`: ```ruby module Foo a = {} # Earlier assignment a[:b] = 1 # This constant fails to parse correctly X = a[:b] end ``` Run...
The `--one-file` flag does not interpret Markdown by default in the `README.md` file (I have not checked other non-source files). ## Steps to reproduce 1. Run the following commands: ```...
