mongodb/bson-ruby Bson ruby

Ruby Implementation of the BSON Specification (2.0.0+)

#53 (all)
Ruby (change)
13 seconds
almost 3 years ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
BSON::Document#merge! N
A
BSON N
A
BSON::ObjectId#to_s N
A
BSON::ObjectId#== N
A
BSON::Binary#== N
A
BSON::CodeWithScope#as_json Ne
A
BSON::Timestamp#as_json Ne
A
BSON::ObjectId#as_json Ne
A
BSON::Regexp#as_json Ne
A
BSON::MinKey#as_json Ne
A
BSON::MaxKey#as_json Ne
A
BSON::Binary#as_json Ne
A
BSON::Code#as_json Ne
A
BSON::Document#delete Ne
A
BSON::Registry#register Ne
A
BSON::Document#merge Ne
A
BSON::MaxKey#<=> Ne
A
BSON::MinKey#<=> Ne
A
BSON::Object#to_bson_normalized_value Ne
A
BSON::Array#to_bson_normalized_value Ne
A
BSON::Binary::InvalidType#initialize Ne
A
BSON::String::IllegalKey#initialize Ne
A
BSON::Hash#to_bson_normalized_value Ne
A
BSON::Object#to_bson_normalized_key Ne
A
BSON::Symbol#to_bson_normalized_key Ne
A
BSON::Binary::InvalidType#message Ne
A
BSON::CodeWithScope#initialize Ne
A
BSON::CodeWithScope#javascript Ne
A
BSON::ObjectId#generation_time Ne
A
BSON::Config#validating_keys= Ne
A
BSON::Regexp::Raw#initialize Ne
A
BSON::ObjectId#marshal_dump Ne
A
BSON::Integer#to_bson_int32 Ne
A
BSON::InvalidKey#initialize Ne
A
BSON::ObjectId#marshal_load Ne
A
BSON::Integer#to_bson_int64 Ne
A
BSON::String#to_hex_string Ne
A
BSON::Timestamp#initialize Ne
A
BSON::FalseClass#bson_type Ne
A
BSON::Document#initialize Ne
A
BSON::Specialized#to_bson Ne
A
BSON::Integer#to_bson_key Ne
A
BSON::Binary::InvalidType Ne
A
BSON::Regexp::Raw#options Ne
A
BSON::TrueClass#bson_type Ne
A
BSON::Regexp::Raw#pattern Ne
A
BSON::Regexp::Raw#compile Ne
A
BSON::ObjectId.from_data Ne
A
BSON::String::IllegalKey Ne
A
BSON::ObjectId.from_bson Ne
A
BSON::Timestamp#seconds Ne
A
BSON::Binary#initialize Ne
A
BSON::ObjectId#inspect Ne
A
BSON::CodeWithScope#== Ne
A
BSON::Code#initialize Ne
A
BSON::Specialized#== Ne
A
BSON::Binary#inspect Ne
A
BSON::ObjectId#hash Ne
A
BSON::ObjectId#=== Ne
A
BSON::Document#[]= Ne
A
BSON::Timestamp#== Ne
A
BSON::JSON#to_json Ne
A
BSON::ObjectId#<=> Ne
A
BSON::Binary#data Ne
A
BSON::Binary#hash Ne
A
BSON::Environment Ne
A
BSON::Document#[] Ne
A
BSON::InvalidKey Ne
A
BSON::ObjectId Ne
A
BSON::Code#== Ne
A
BSON::Config Ne
A
BSON::Object Ne
A
BSON::JSON Ne
A
BSON::Date#bson_type Ne
A
BSON::CodeWithScope#javascript= Ne
A
BSON::Timestamp#seconds= Ne
A
BSON::Binary#data= Ne
A
BSON::Specialized::ClassMethods#from_bson E
A
BSON::NilClass::ClassMethods#from_bson E
A
BSON::Symbol::ClassMethods#from_bson E
A
BSON::Regexp::ClassMethods#from_bson E
A
BSON::String::ClassMethods#from_bson E
A
BSON::Array::ClassMethods#from_bson E
A
BSON::Float::ClassMethods#from_bson E
A
BSON::Hash::ClassMethods#from_bson E
A
BSON::Time::ClassMethods#from_bson E
A
BSON::String#to_bson_object_id E
A
BSON::CodeWithScope.from_bson E
A
BSON::Array#to_bson_object_id E
A
BSON::CodeWithScope#to_bson E
A
BSON::ObjectId.from_string E
A
BSON::Timestamp.from_bson E
A
BSON::Object#to_bson_key E
A
BSON::String#to_bson_key E
A
BSON::ObjectId.from_time E
A
BSON::FalseClass#to_bson E
A
BSON::Symbol#to_bson_key E
A
BSON::Timestamp#to_bson E
A
BSON::Boolean.from_bson E
A
BSON::Integer#bson_type E
A
BSON::TrueClass#to_bson E
A
BSON::ObjectId#to_bson E
A
BSON::Binary.from_bson E
A
BSON::Symbol#bson_type E
A
BSON::DateTime#to_bson E
A
BSON::Integer#to_bson E
A
BSON::Int64.from_bson E
A
BSON::ObjectId.repair E
A
BSON::Int32.from_bson E
A
BSON::Regexp#to_bson E
A
BSON::String#to_bson E
A
BSON::Binary#to_bson E
A
BSON::Symbol#to_bson E
A
BSON::Code.from_bson E
A
BSON::Float#to_bson E
A
BSON::Array#to_bson E
A
BSON::CodeWithScope E
A
BSON::Hash#to_bson E
A
BSON::Registry#get E
A
BSON::Date#to_bson E
A
BSON::Code#to_bson E
A
BSON::Time#to_bson E
A
BSON::Specialized E
A
BSON::Regexp::Raw E
A
BSON::FalseClass E
A
BSON::Undefined E
A
BSON::Timestamp E
A
BSON::TrueClass E
A
BSON::Registry E
A
BSON::Document E
A
BSON::DateTime E
A
BSON::Integer E
A
BSON.ObjectId E
A
BSON::Boolean E
A
BSON::MaxKey E
A
BSON::Symbol E
A
BSON::Regexp E
A
BSON::Binary E
A
BSON::String E
A
BSON::MinKey E
A
BSON::Array E
A
BSON::Float E
A
BSON::Int32 E
A
BSON::Int64 E
A
BSON::Time E
A
BSON::Code E
A
BSON::Hash E
A
BSON::Date E
A
BSON::Document#has_value? E
A
BSON::Document#has_key? E
A
BSON::Undefined#== E
Proper documentation present
Please take a look

Let's raise the visibility of documentation in Open Source!

This page is for mongodb/bson-ruby and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.