GithubHelp home page GithubHelp logo

Comments (5)

rrrene avatar rrrene commented on July 29, 2024

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! :neckbeard:

from inch.

denisdefreyne avatar denisdefreyne commented on July 29, 2024

Works like a charm, thanks! (Nice and green now)

from inch.

yasuhito avatar yasuhito commented on July 29, 2024

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.

rrrene avatar rrrene commented on July 29, 2024

Ah, so we are kind-of half-way there 😄

Ok, I will have a look!

from inch.

rrrene avatar rrrene commented on July 29, 2024

@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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.