Comments (5)
Hi there,
I'm not sure I ever got back to you about this. It should be fixed by now (0.4 release to be precise).
I will close this ticket, but if it wasn't fixed just call me out on it! Thanks for your bug report!
from inch.
Works like a charm, thanks! (Nice and green now)
from inch.
Hi, this issue seems still exists with inch 0.4.2.
Code:
# Creates a Hello OpenFlow message.
#
# @overload initialize()
# @example
# Hello.new
#
# @overload initialize(transaction_id)
# @example
# Hello.new(123)
# @param [Number] transaction_id
# An unsigned 32-bit integer number associated with this
# message. If not specified, an auto-generated value is set.
#
# @overload initialize(user_options)
# @example
# Hello.new(transaction_id: 123)
# Hello.new(xid: 123)
# @param [Hash] user_options the options to create a message with.
# @option user_options [Number] :transaction_id
# @option user_options [Number] :xid an alias to transaction_id.
def initialize(user_options = {})
#...
has this output:
$ inch show "Pio::Hello#initialize"
# Pio::Hello#initialize
┃ -> /Users/yasuhito/play/pio/lib/pio/hello.rb:45
┃ ----------------------------------------------------------------
┃ Grade: A - Seems really good
┃ ----------------------------------------------------------------
┃ + Add a code example (optional)
┃ + Describe the parameter 'user_options'
┃ + Describe the parameter 'transaction_id'
┃ ----------------------------------------------------------------
The comments are correctly graded as A but suggestions does not disappear.
from inch.
Ah, so we are kind-of half-way there
Ok, I will have a look!
from inch.
@yasuhito I just released Inch 0.4.3, which fixes the problem described above.
Thanks again for your detailed bug report!
from inch.
Related Issues (20)
- Support for puppet modules HOT 2
- Support a literate coding view HOT 3
- RDoc support HOT 11
- add way to parse the rdoc/yard documentation in C/C++ code HOT 3
- Documentation tag @return leads to skip the documentation analysis for a method HOT 4
- Inch shouldn't complain about the parameter '_' being undocumented in Ruby HOT 3
- inch terminates with exception HOT 2
- Problem with branches HOT 3
- Problems with using inch HOT 1
- inch diff fails, when workdir != repo-root HOT 2
- Support for the Crystal Programming Language HOT 7
- Support RDoc's :stopdoc: HOT 1
- Incorrect support for RDoc virtual methods HOT 3
- Update Inch to user a newer YARD HOT 16
- Incredibly tight runtime dependency requirement HOT 1
- Exclude Frozen Ruby String Declarations HOT 2
- Fix Ruby warnings
- Do not include Term::ANSIColor into String HOT 1
- Do not count TODO, FIXME, etc. comments HOT 4
- Inch failing to create page HOT 5
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from inch.