Code Monkey home page Code Monkey logo

spell_generator's Issues

Include the travis build status image in the README

Hey there :),

I noticed that there is files for specs, travis, and rubocop. I think it would be good to add the travis status image within the README. I often find this useful to tell me at a quick glance that this project is properly tested and I gain confidence in the code :).

self_generate misuse should raise an Error

As discussed in #8 :

self_generate() method expects two arguments to be given.

When used with another number of arguments, it is expected to raise a SpellGeneratorError.

However, when used with one argument, for example, self_generate still produces an output without raising any error.

Examples of unexpected behavior:

SpellGenerator::Generator.new.self_generate('RandomFire') #=> RandomFire
SpellGenerator::Generator.new.self_generate('Random' 'Fire') #=> RandomFire (no comma between strings: treated as only one argument, like the line above)

Missing comma in README

Follow-up to #8 :
In README.md «Usage» section, there is a missing comma between function arguments.

SpellGenerator::Generator.new.self_generate('Random' 'Fire') #=> "Random Fire"

Fix typos in README usage section

  • Trailing «r» missing for «Generator»:
SpellGenerator::Generato.new.generate #=> "Symptomatic punch"
  • Trailing «r» missing for «Generator»; missing comma between arguments if given output is what's expected:
SpellGenerator::Generato.new.self_generate('Random' 'Fire') #=> "Random Fire"

Fixing this does not require to write code (but requires to execute it to validate solution !)

Given output does not match code execution in README usage section

In the following usage example:

SpellGenerator::Generator.generate #=> "Brave fire"
SpellGenerator::Generato.new.generate #=> "Symptomatic punch"

Given output is capitalized, but when code is executed, result is lower case:

@K-Sato1995 : what's the fix supposed to be?

  • If capitalized output is not an expected feature: adjust README given output to match actual output. In this case, this issue is related to #8.

  • If capitalized output is an expected feature: fix code to capitalize ouput

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.