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

estimancy/projestimate

ProjEstimate a web Open Source application for projects estimation. ProjEstimate is written using Ruby on Rails framework, more details can be found on the web site – Read the documentation

This page shows an evaluation of the documentation of estimancy/projestimate.

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
ApplicationController
A
ProjectsController
A
User
A
OrganizationLaborCategoriesController
A
WbsActivityRatioElementsController
Show 235 more ...
A
AcquisitionCategoriesController
A
ProjectSecurityLevelsController
A
WbsActivityElementsController
A
PbsProjectElementsController
A
PlatformCategoriesController
A
WbsProjectElementsController
A
ActivityCategoriesController
A
WbsActivityRatiosController
A
ProjectCategoriesController
A
ProjectSecuritiesController
A
WorkElementTypesController
A
EstimationValuesController
A
AttributeModulesController
A
LaborCategoriesController
A
WbsActivityElementsHelper
A
PemoduleEstimationMethods
A
ReferenceValuesController
A
ModuleProjectsController
A
MasterSettingsController
A
PasswordResetsController
A
RecordStatusesController
A
AdminSettingsController
A
OrganizationsController
A
PeAttributesController
A
TranslationsController
A
ProjectAreasController
A
ModuleProjectObserver
A
AuthMethodsController
A
PermissionsController
A
DataValidationHelper
A
EventTypesController
A
ModuleProjectsHelper
A
CurrenciesController
A
PeWbsProjectsHelper
A
LanguagesController
A
PemodulesController
A
AcquisitionCategory
A
WbsActivitiesHelper
A
SearchesController
A
WbsActivityElement
A
VersionsController
A
SessionsController
A
PeiconsController
A
PbsProjectElement
A
WbsProjectElement
A
ApplicationHelper
A
ActivityCategory
A
WbsActivityRatio
A
PlatformCategory
A
EventsController
A
GroupsController
A
ProjectCategory
A
AttributeModule
A
ExternalInclude
A
HomesController
A
UsersController
A
WorkElementType
A
ProjectSecurity
A
EstimationValue
A
SearchesHelper
A
ReferenceValue
A
ModuleProject
A
RecordStatus
A
UserObserver
A
AdminSetting
A
PeWbsProject
A
Organization
A
UsersHelper
A
PeAttribute
A
ProjectArea
A
UserMailer
A
AuthMethod
A
Pemodule
A
Language
A
Ability
A
Group
A
Home
A
Home.load_master_data!
A
User#name
A
#selected_pbs_project_element:: ::
A
#selected_wbs_project_element:: ::
A
ProjectsController#update_project_security_level_group
A
WbsActivitiesController#validate_change_with_children
A
WbsProjectElementsController#change_wbs_project_ratio
A
ProjectsController#load_security_for_selected_group
A
ProjectsController#load_security_for_selected_user
A
PermissionsController#set_rights_project_security
A
ProjectsController#update_project_security_level
A
ProjectsController#refresh_wbs_activity_ratios
A
WbsActivitiesController#duplicate_wbs_activity
A
ProjectsController#add_wbs_activity_to_project
A
PemodulesController#update_selected_attributes
A
ApplicationController#set_locale_from_browser
A
WbsProjectElement#get_all_complement_children
A
SessionsController#reset_forgotten_password
A
WbsProjectElement#update_can_get_new_child
A
ProjectsController#change_selected_project
A
PemodulesController#set_attributes_module
A
PeAttributesController#find_use_attribute
A
MasterDataHelper#record_status_collection
A
ApplicationController#get_record_statuses
A
TranslationsController#load_translations
A
ProjectSecuritiesController#select_users
A
SessionsController#forgotten_password
A
WbsProjectElementsController#destroy
A
DataValidationHelper#validate_change
A
UsersController#create_inactive_user
A
DataValidationHelper#restore_change
A
WbsProjectElementsController#update
A
WbsProjectElementsController#create
A
WbsProjectElementsController#index
A
SessionsController#ask_new_account
A
ProjectsController#run_estimation
A
User#group_for_project_securities
A
PbsProjectElementsController#down
A
WbsProjectElementsController#show
A
WbsProjectElementsController#edit
A
User#group_for_global_permissions
A
WbsProjectElementsController#new
A
PemodulesController#pemodules_up
A
PbsProjectElementsController#new
A
MasterSettingsController#destroy
A
RecordStatusesController#destroy
A
PermissionsController#set_rights
A
RecordStatusesController#create
A
MasterSettingsController#update
A
PbsProjectElementsController#up
A
MasterSettingsController#create
A
RecordStatusesController#update
A
PasswordResetsController#update
A
WorkElementTypesController#edit
A
ModuleProject#output_attributes
A
MasterSettingsController#index
A
PeWbsProject#project_id_exists
A
ProjectsHelper#display_results
A
PeAttribute#explicit_data_type
A
RecordStatusesController#index
A
ModuleProject#input_attributes
A
ProjectsController#add_module
A
MasterSettingsController#edit
A
SessionsController#help_login
A
PermissionsController#destroy
A
RecordStatusesController#show
A
PasswordResetsController#edit
A
RecordStatusesController#edit
A
TranslationsController#create
A
PermissionsController#create
A
CurrenciesController#destroy
A
ProjectsHelper#display_input
A
RecordStatusesController#new
A
MasterSettingsController#new
A
PeAttribute.type_aggregation
A
ReferenceValue#record_status
A
PermissionsController#update
A
TranslationsController#index
A
ProjectsController#duplicate
A
CurrenciesController#update
A
CurrenciesController#create
A
LanguagesController#destroy
A
PermissionsController#edit
A
UserMailer#account_request
A
SessionsController#destroy
A
SearchesController#results
A
VersionsController#destroy
A
PeAttribute#attribute_type
A
CurrenciesController#edit
A
ProjectsController#create
A
VersionsController#update
A
VersionsController#create
A
PeiconsController#destroy
A
SessionsController#create
A
SessionsController#login
A
VersionsController#index
A
CurrenciesController#new
A
User#send_password_reset
A
ModuleProject#following
A
ModuleProject#preceding
A
ProjectsController#edit
A
VersionsController#edit
A
VersionsController#show
A
ModuleProject#previous
A
PbsProjectElement#to_s
A
UsersController#update
A
VersionsController#new
A
Project#root_component
A
EventsController#index
A
PlatformCategory#to_s
A
PeAttribute#data_type
A
User#encrypt_password
A
ProjectSecurity#level
A
EventsController#edit
A
UsersController#show
A
User#password_length
A
ProjectCategory#to_s
A
WorkElementType#to_s
A
User#latest_project
A
Group#record_status
A
ModuleProject#next
A
Organization#to_s
A
User#admin_groups
A
PeAttribute#to_s
A
ProjectArea#to_s
A
Project#folders
A
Project#states
A
Language#to_s
A
Pemodule#to_s
A
Project#to_s
A
Group#to_s
A
User#to_s
A
ModuleProjectsPbsProjectElement
A
OrganizationLaborCategory
A
WbsProjectElementsHelper
A
PeWbsProjectsController
A
AssociatedModuleProject
A
WbsActivityRatioElement
A
EstimationValuesHelper
A
ReferenceValuesHelper
A
MasterSettingsHelper
A
ProjectSecurityLevel
A
RecordStatusesHelper
A
AdminSettingsHelper
A
PermissionObserver
A
AuthMethodsHelper
A
ProjectObserver
A
VersionsHelper
A
LaborCategory
A
MasterSetting
A
WbsActivity
A
HomesHelper
A
Permission
A
EventType
A
Currency
A
Version
A
Peicon
A
Event
Proper documentation present
B
ModuleProjectsHelper#compute_probable_value
B
PeWbsProjectsHelper#generate_wbs_product
B
ProjectsHelper#display_text_field_tag
B
ModuleProject.common_attributes
B
#compact_array_and_compute_node_value:: ::
Show 37 more ...
B
#generate_activity_element_tree:: ::
B
WbsActivityElementsHelper#generate_wbs_project_elt_tree
B
ProjectsController#set_wbs_completion_node_consistency
B
ProjectsController#compute_tree_node_estimation_value
B
ProjectsController#set_element_value_with_activities
B
ProjectsHelper#display_inputs_without_activities
B
ProjectsHelper#display_results_with_activities
B
ProjectsHelper#display_inputs_with_activities
B
ProjectsHelper#display_effort_balancing_input
B
ProjectsController#set_element_consistency
B
ProjectsController#run_estimation_plan
B
ModuleProjectsHelper#probable_value
B
Group#project_securities_for_select
B
WbsProjectElement.arrange_as_array
B
User#project_securities_for_select
B
UserMailer#account_validate_no_pw
B
UserMailer#account_validate_ldap
B
UserMailer#forgotten_password
B
ApplicationHelper#page_title
B
ProjectsHelper#display_value
B
UserMailer#account_suspended
B
UserMailer#account_validate
B
AttributeModule#is_validate
B
ProjectsHelper#display_date
B
ProjectsHelper#display_rule
B
EstimationValue#is_validate
B
ApplicationHelper#sortable
B
UserMailer#account_created
B
User#delete_recent_project
B
User#add_recent_project
B
UserMailer#new_password
B
Project#project_value
B
User#generate_token
B
Home.create_records
B
Ability#initialize
B
User.table_search
B
User.authenticate
Needs work
Undocumented
U
ApplicationHelper#pop_up
U
Home.update_master_data!
U
WbsActivitiesController
U
MasterDataHelper
U
PemodulesHelper
Show 293 more ...
U
ProjectsHelper
U
PeWbsHelper
U
Project
U
ProjectsHelper#pemodule_input
U
ProjectsHelper#display_path
U
ExternalMasterDatabase
U
PeWbsProjectsHelper#wbs_navigation_links
U
PeWbsProjectsHelper#wbs_folder_links
U
#wbs_record_statuses_collection:: ::
U
#update_wbs_project_ratio_value:: ::
U
#associate_module_project_to_ratios:: ::
U
#refresh_pbs_activity_ratios:: ::
U
WbsActivityElementsController#update_status_collection
U
WbsActivitiesController#wbs_record_statuses_collection
U
AdminSettingsController#admin_setting_selected_status
U
WbsProjectElementsController#disabled_if_from_library
U
ModuleProjectsController#associate_modules_projects
U
AttributeModulesController#check_attribute_modules
U
ApplicationController#current_wbs_project_element
U
ProjectsController#create_wbs_activity_from_child
U
ProjectsHelper#display_results_without_activities
U
ProjectsController#refresh_wbs_project_elements
U
WbsActivityElementsHelper#link_activity_element
U
ModuleProjectsController#module_projects_matrix
U
ProjectAreasController#get_associations_records
U
WbsActivitiesController#refresh_ratio_elements
U
ProjectsController#select_pbs_project_elements
U
OrganizationsController#organizationals_params
U
WbsActivityRatioElementsController#save_values
U
ProjectsHelper#display_effort_balancing_output
U
OrganizationLaborCategoriesController#destroy
U
ProjectsController#default_work_element_type
U
OrganizationLaborCategoriesController#update
U
OrganizationLaborCategoriesController#create
U
GroupsController#user_organizations_projects
U
ApplicationController#verify_authentication
U
OrganizationLaborCategoriesController#index
U
AdminSettingsController#unselect_conditions
U
WbsActivityElementsHelper#show_element_name
U
ProjectsHelper#build_find_use_project_popup
U
ModuleProjectsController#pbs_element_matrix
U
WbsActivityRatiosController#validate_ratio
U
OrganizationLaborCategoriesController#edit
U
ApplicationController#update_activity_time
U
ProjectsController#projects_global_params
U
GroupsController#user_organizations_users
U
PermissionsController#globals_permissions
U
OrganizationLaborCategoriesController#new
U
WbsActivitiesHelper#page_navigation_links
U
ApplicationController#load_master_setting
U
ApplicationController#session_expiration
U
ApplicationController#load_admin_setting
U
ApplicationController#set_user_time_zone
U
AcquisitionCategoriesController#destroy
U
WbsActivityRatioElementsController#edit
U
EstimationValuesController#generate_pdf
U
ProjectSecurityLevelsController#destroy
U
ApplicationController#set_user_language
U
ApplicationController#current_component
U
ProjectSecurityLevelsController#update
U
PemodulesController#estimations_params
U
PeAttributesController#check_attribute
U
ProjectSecurityLevelsController#create
U
WorkElementType.work_element_type_list
U
WbsActivityRatioElementsController#new
U
AcquisitionCategoriesController#create
U
PemodulesHelper#display_attribute_rule
U
AcquisitionCategoriesController#update
U
ApplicationController#current_project
U
ProjectSecurityLevelsController#index
U
UsersHelper#build_find_use_user_popup
U
WbsActivityElementsController#destroy
U
AcquisitionCategoriesController#edit
U
PbsProjectElementsController#destroy
U
ProjectSecurityLevelsController#edit
U
ProjectsController#select_categories
U
ApplicationController#set_page_title
U
ActivityCategoriesController#destroy
U
WbsActivityElementsController#update
U
WbsActivityElementsController#create
U
PlatformCategoriesController#destroy
U
WbsActivityElement#wbs_activity_name
U
GroupsController#associated_projects
U
ModuleProjectObserver#before_destroy
U
ProjectsController#get_new_ancestors
U
ProjectCategoriesController#destroy
U
ApplicationController#previous_page
U
PbsProjectElementsController#update
U
ActivityCategoriesController#create
U
PlatformCategoriesController#update
U
ApplicationController#set_return_to
U
ProjectSecuritiesController#destroy
U
ApplicationController#redirect_save
U
ActivityCategoriesController#update
U
PlatformCategoriesController#create
U
AcquisitionCategoriesController#new
U
WbsActivityRatiosController#destroy
U
ProjectSecurityLevelsController#new
U
ProjectsController#confirm_deletion
U
PemodulesController#pemodules_right
U
ProjectSecuritiesController#create
U
ProjectSecuritiesController#update
U
ActivityCategoriesController#index
U
SearchesHelper#display_description
U
ApplicationController#current_user
U
ModuleProjectsController#associate
U
WbsActivityRatiosController#export
U
EstimationValuesController#convert
U
PemodulesController#pemodules_left
U
PemodulesController#pemodules_down
U
PeWbsProjectsHelper#wbs_root_links
U
ProjectCategoriesController#update
U
WbsActivityRatiosController#import
U
WbsActivityRatiosController#update
U
ProjectCategoriesController#create
U
WbsActivityRatiosController#create
U
AttributeModulesController#destroy
U
ApplicationHelper#javascript_heads
U
WbsActivityElementsController#edit
U
WbsActivityElementsController#show
U
WorkElementTypesController#destroy
U
GroupsController#associated_users
U
ApplicationController#current_url
U
WorkElementTypesController#update
U
WorkElementTypesController#create
U
WbsActivityElementsController#new
U
PbsProjectElementsController#edit
U
PlatformCategoriesController#edit
U
AttributeModulesController#create
U
ProjectsController#choose_project
U
ActivityCategoriesController#edit
U
ProjectsController#sort_direction
U
ProjectSecuritiesController#index
U
EstimationValuesController#update
U
LaborCategoriesController#destroy
U
ReferenceValuesController#destroy
U
WbsActivityElement.build_ancestry
U
ModuleProjectsController#destroy
U
ReferenceValuesController#create
U
WorkElementTypesController#index
U
ProjectSecuritiesController#edit
U
ProjectCategoriesController#edit
U
ReferenceValuesController#update
U
PlatformCategoriesController#new
U
Project#wbs_project_element_root
U
WbsActivityRatiosController#edit
U
LaborCategoriesController#update
U
LaborCategoriesController#create
U
PeAttribute.attribute_updated_at
U
ActivityCategoriesController#new
U
WbsActivitiesController#destroy
U
ProjectSecuritiesController#new
U
ProjectsController#destroy_save
U
ModuleProjectsController#update
U
ModuleProjectsController#create
U
ProjectCategoriesController#new
U
OrganizationsController#destroy
U
ReferenceValuesController#index
U
LaborCategoriesController#index
U
WbsActivityRatiosController#new
U
EstimationValuesController#edit
U
AdminSettingsController#destroy
U
UsersController#display_states
U
WbsActivitiesController#import
U
WbsActivitiesController#update
U
HomesController#update_install
U
AdminSettingsController#update
U
AdminSettingsController#create
U
WbsActivitiesController#create
U
ProjectsController#locked_plan
U
LaborCategoriesController#edit
U
ModuleProjectsController#index
U
OrganizationsController#update
U
OrganizationsController#create
U
ProjectAreasController#destroy
U
ProjectsController#sort_column
U
ReferenceValuesController#edit
U
PeAttributesController#destroy
U
WbsProjectElement#destroy_leaf
U
WorkElementTypesController#new
U
ApplicationController#redirect
U
ProjectAreasController#update
U
WbsActivitiesController#index
U
ReferenceValuesController#new
U
SearchesHelper#display_update
U
ProjectAreasController#create
U
LaborCategoriesController#new
U
ModuleProject#compatible_with
U
ModuleProjectsController#edit
U
PeAttributesController#create
U
PeiconsController#choose_icon
U
PeAttributesController#update
U
AuthMethodsController#destroy
U
UsersController#find_use_user
U
AdminSettingsController#index
U
ProjectsController#load_data
U
AdminSettingsController#edit
U
PeAttributesController#index
U
AuthMethodsController#update
U
OrganizationsController#edit
U
WbsActivitiesController#edit
U
EventTypesController#destroy
U
AuthMethodsController#create
U
WbsActivitiesController#new
U
OrganizationsController#new
U
User#password_confirmation=
U
AuthMethodsController#index
U
ProjectAreasController#edit
U
PermissionsController#index
U
EventTypesController#update
U
ProjectsController#find_use
U
ProjectsController#activate
U
EventTypesController#create
U
AdminSettingsController#new
U
SearchesHelper#display_link
U
PeAttributesController#edit
U
PemodulesController#destroy
U
ProjectsController#destroy
U
CurrenciesController#index
U
PeAttributesController#new
U
LanguagesController#create
U
PemodulesController#create
U
PemodulesController#update
U
PeAttribute.attribute_list
U
LanguagesController#update
U
EventTypesController#index
U
ProjectAreasController#new
U
WbsActivityElement.rebuild
U
AuthMethodsController#edit
U
User#password_confirmation
U
AuthMethodsController#new
U
UsersController#load_data
U
ProjectsController#commit
U
LanguagesController#index
U
PemodulesController#index
U
PeAttribute.value_options
U
UserObserver#after_update
U
CurrenciesController#show
U
PermissionsController#new
U
EventTypesController#edit
U
WbsActivityElement.import
U
ProjectsController#update
U
EventsController#destroy
U
LanguagesController#edit
U
AcquisitionCategory#to_s
U
UsersController#activate
U
EventTypesController#new
U
PeiconsController#create
U
ProjectsController#index
U
PeiconsController#update
U
PemodulesController#edit
U
GroupsController#destroy
U
User#ldap_authentication
U
WbsActivityRatio.export
U
PeAttribute.type_values
U
UsersController#destroy
U
GroupsController#update
U
WbsActivityRatio.import
U
Home.latest_repo_update
U
PemodulesController#new
U
GroupsController#create
U
EventsController#create
U
EventsController#update
U
PeiconsController#index
U
LanguagesController#new
U
PeiconsController#edit
U
ProjectsController#new
U
UsersController#create
U
SessionsController#new
U
GroupsController#index
U
UsersController#about
U
ActivityCategory#to_s
U
GroupsController#edit
U
PeiconsController#new
U
UsersController#index
U
GroupsController#new
U
EstimationValue#to_s
U
Project.table_search
U
UsersController#edit
U
EventsController#new
U
Home.update_records
U
UsersController#new
U
ModuleProject#links
U
ModuleProject#to_s
U
RecordStatus#to_s
U
Project.encoding
U
AuthMethod#to_s
U
User#password=
U
User#password
U
User#locale
U
User#tz
U
UserMailer#reset_locale
U
PeAttributesHelper

Let's raise the visibility of documentation in Ruby!

This page is for estimancy/projestimate 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