Let's raise the visiblity of code documentation in Ruby! What is this about?

alakra/ndfd-weather-forecast-client

Client library for retrieving data from NOAA's weather forecast API – Read the documentation

This page shows an evaluation of the documentation of alakra/ndfd-weather-forecast-client.

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
NDFD
A
NDFD::Client::SelectionAttributes#attributes
A
NDFD::DWML::ParameterExtractor#time_layouts
A
NDFD::Client::QueryProperty#required_keys
A
NDFD::DWML::ParameterExtractor#location
Show 33 more ...
A
NDFD::DWML::TimeLayout::ValidTime#start
A
NDFD::DWML::TimeLayout::ValidTime#stop
A
NDFD::DWML::ParameterExtractor#element
A
NDFD::DWML::TimeLayout#time_coordinate
A
NDFD::DWML::ParameterExtractor#output
A
NDFD::Client::Query#select_attributes
A
NDFD::Client::QueryProperty#required
A
NDFD::DWML::TimeLayout#summarization
A
NDFD::Client::QueryProperty#default
A
NDFD::Client::QueryProperty#options
A
NDFD::DWML::TimeLayout#valid_times
A
NDFD::DWML::Location#location_key
A
NDFD::DWML::TimeLayout#layout_key
A
NDFD::DWML::DataExtractor#element
A
NDFD::DWML::HeadExtractor#element
A
NDFD::DWML::DataExtractor#output
A
NDFD::Client::QueryProperty#name
A
NDFD::Client::QueryProperty#type
A
NDFD::DWML::HeadExtractor#output
A
NDFD::Client::Query#soap_client
A
NDFD::DWML::TimeLayout#element
A
NDFD::DWML::Location#longitude
A
NDFD::Client::Query#conditions
A
NDFD::DWML::Location#latitude
A
NDFD::DWML::Location#element
A
NDFD::DWML#xmldoc
A
NDFD::DWML#output
A
NDFD::Client::QueryProperty#required_keys=
A
NDFD::Client::QueryProperty#required=
A
NDFD::Client::QueryProperty#default=
A
NDFD::Client::QueryProperty#options=
A
NDFD::Client::QueryProperty#type=
A
NDFD::Client::QueryProperty#name=
Proper documentation present
B
NDFD::Client#select
Needs work
Undocumented
U
NDFD::Client::Query.set_selection_attributes
U
NDFD::DWML::ParameterExtractor
U
NDFD::Client::QueryProperty
U
NDFD::Client
U
NDFD::Client::QueryUtilities#transform_coordinate_list
Show 123 more ...
U
NDFD::Client::QueryUtilities#build_coordinates
U
NDFD::Client::SelectLinepointCoordinatesQuery
U
NDFD::Client::SelectGridpointCoordinatesQuery
U
NDFD::Client::SelectionAttributes#initialize
U
NDFD::DWML::TimeLayout::ValidTime#initialize
U
NDFD::Client::SelectCoordinatesByCitiesQuery
U
NDFD::Client::SelectCornerCoordinatesQuery
U
NDFD::Client::SelectSquareCoordinatesQuery
U
NDFD::Client::HelpConsole#display_welcome
U
NDFD::Client#select_linepoint_coordinates
U
NDFD::Client#select_gridpoint_coordinates
U
NDFD::Client#select_coordinates_by_cities
U
NDFD::Client::SelectCoordinatesByZipQuery
U
NDFD::DWML::ParameterExtractor#initialize
U
NDFD::Client::Query.selection_attributes
U
NDFD::Client::QueryProperty#initialize
U
NDFD::Client#select_coordinates_by_zip
U
NDFD::Client#select_corner_coordinates
U
NDFD::DWML::ParameterExtractor#process
U
NDFD::Client#select_square_coordinates
U
NDFD::DWML::HeadExtractor#initialize
U
NDFD::DWML::DataExtractor#initialize
U
NDFD::DWML::HeadExtractor#process
U
NDFD::Client::SelectionAttributes
U
NDFD::DWML::TimeLayout#initialize
U
NDFD::DWML::DataExtractor#process
U
NDFD::DWML::TimeLayout::ValidTime
U
NDFD::DWML::Location#initialize
U
NDFD::Client::SelectByDaysQuery
U
NDFD::DWML::TimeLayout.extract
U
NDFD::Client::Query#initialize
U
NDFD::Client::Query.properties
U
NDFD::Client::QueryUtilities
U
NDFD::Client::Query#validate
U
NDFD::Client::Query.property
U
NDFD::DWML::Location.extract
U
NDFD::Client::Query#execute
U
NDFD::Client#select_by_days
U
NDFD::Client::SelectQuery
U
NDFD::DWML::HeadExtractor
U
NDFD::Client::HelpConsole
U
NDFD::DWML::DataExtractor
U
NDFD::Client::Query#where
U
NDFD::Client#soap_client
U
NDFD::Client#initialize
U
NDFD::DWML::TimeLayout
U
NDFD::DWML#initialize
U
NDFD::DWML::Location
U
NDFD::Client::Query
U
NDFD::DWML#process
U
NDFD.vendor_path
U
NDFD.root_path
U
NDFD.client
U
NDFD::DWML
U
NDFD.env
U
NDFD:: #transform_document_to_mapped_list
U
NDFD:: #transform_document_to_mapped_list
U
NDFD:: #extract_probability_of_precipitation
U
NDFD:: #extract_convective_hazard_severity
U
NDFD:: #extract_convective_hazard_outlook
U
NDFD:: #raise_required_keys_missing_error
U
NDFD:: #build_message
U
NDFD:: #build_message
U
NDFD:: #build_message
U
NDFD:: #build_message
U
NDFD:: #extract_basic_time_series
U
NDFD:: #build_message
U
NDFD:: #extract_convective_hazard
U
NDFD::DWML::ParameterExtractor#extract_conditions_icons
U
NDFD::Client::QueryProperty#check_required_keys_missing
U
NDFD::Client::SelectCoordinatesByZipQuery#build_message
U
NDFD::Client::SelectGridpointCoordinatesQuery#parse_xml
U
NDFD::Client::SelectLinepointCoordinatesQuery#parse_xml
U
NDFD::DWML::ParameterExtractor#extract_climate_anomaly
U
NDFD::Client::SelectCoordinatesByCitiesQuery#parse_xml
U
NDFD::DWML::ParameterExtractor#extract_wind_direction
U
NDFD::Client::SelectCornerCoordinatesQuery#parse_xml
U
NDFD::Client::SelectSquareCoordinatesQuery#parse_xml
U
NDFD::DWML::ParameterExtractor#extract_precipitation
U
NDFD::Client::SelectCoordinatesByZipQuery#parse_xml
U
NDFD::DWML::ParameterExtractor#extract_temperatures
U
NDFD::DWML::ParameterExtractor#extract_fire_weather
U
NDFD::DWML::ParameterExtractor#extract_water_state
U
NDFD::Client::QueryProperty#validate_required_keys
U
NDFD::Client::SelectQuery#build_weather_parameters
U
NDFD::DWML::ParameterExtractor#extract_cloud_cover
U
NDFD::DWML::ParameterExtractor#extract_wind_speed
U
NDFD::DWML::ParameterExtractor#lookup_time_layout
U
NDFD::Client::Query#validate_selection_attributes
U
NDFD::DWML::DataExtractor#location_for_parameter
U
NDFD::DWML::ParameterExtractor#extract_humidity
U
NDFD::DWML::ParameterExtractor#extract_hazards
U
NDFD::DWML::ParameterExtractor#extract_weather
U
NDFD::DWML::DataExtractor#extract_time_layouts
U
NDFD::DWML::TimeLayout#extract_time_coordinate
U
NDFD::Client::QueryProperty#validate_required
U
NDFD::Client::SelectByDaysQuery#build_message
U
NDFD::DWML::TimeLayout#extract_summarization
U
NDFD::Client::QueryProperty#validate_options
U
NDFD::DWML::DataExtractor#extract_parameters
U
NDFD::DWML::DataExtractor#extract_locations
U
NDFD::Client::SelectQuery#transform_to_hash
U
NDFD::DWML::TimeLayout#extract_valid_times
U
NDFD::Client::Query#set_defaults_as_needed
U
NDFD::Client::QueryProperty#validate_type
U
NDFD::DWML::TimeLayout#extract_layout_key
U
NDFD::Client::Query#available_selections
U
NDFD::Client::SelectQuery#build_message
U
NDFD::Client::Query#validate_conditions
U
NDFD::DWML::HeadExtractor#build_product
U
NDFD::DWML::HeadExtractor#build_source
U
NDFD::DWML::Location#extract_coords
U
NDFD::DWML::Location#extract_key
U
NDFD::DWML#build_data
U
NDFD::DWML#build_head
U
NDFD::Client::SelectGridpointCoordinatesQuery#execute
U
NDFD::Client::SelectLinepointCoordinatesQuery#execute
U
NDFD::Client::SelectCoordinatesByCitiesQuery#execute
U
NDFD::Client::SelectSquareCoordinatesQuery#execute
U
NDFD::Client::SelectCornerCoordinatesQuery#execute
U
NDFD::Client::SelectCoordinatesByZipQuery#execute
U
NDFD::Client::SelectByDaysQuery#execute
U
NDFD::Client::SelectQuery#execute

Let's raise the visiblity of documentation in Ruby!

This page is for alakra/ndfd-weather-forecast-client and is part of a project called "Inch Pages", showing documentation measurements provided by Inch. Inch Pages also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

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.

Fork me on GitHub