This page shows an evaluation of the documentation of Shopify/liquid.
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
|
Module | |
A
|
Liquid::Context | |
A
|
Liquid | |
A
|
Liquid::Template | |
A
|
Liquid::Document#assert_missing_delimitation! | |
Show 23 more ... | ||
A
|
Liquid::Template#initialize | |
A
|
Liquid::BlankFileSystem | |
A
|
Liquid::LocalFileSystem | |
A
|
Liquid::Interrupt | |
A
|
Liquid::Increment | |
A
|
Liquid::Decrement | |
A
|
Liquid::Variable | |
A
|
Liquid::Continue | |
A
|
Liquid::Capture | |
A
|
Liquid::Include | |
A
|
Liquid::Unless | |
A
|
Liquid::Assign | |
A
|
Liquid::Break | |
A
|
Liquid::Cycle | |
A
|
Liquid::Drop | |
A
|
Liquid::For | |
A
|
Liquid::If | |
A
|
Liquid::Context#pop_interrupt | |
A
|
Liquid::Template.error_mode= | |
A
|
Liquid::Template#parse | |
A
|
Liquid::Context#pop | |
A
|
Liquid::Document#block_delimiter | |
A
|
Liquid::Block#warnings |
Proper documentation present | ||
---|---|---|
B
|
Liquid::Drop#invoke_drop | |
B
|
Liquid::Context#push_interrupt | |
B
|
Liquid::Template#render | |
B
|
Liquid::StandardFilters#date | |
B
|
Liquid::Context#stack | |
Show 32 more ... | ||
B
|
Liquid::BlankFileSystem#read_template_file | |
B
|
Liquid::StandardFilters#strip_newlines | |
B
|
Liquid::StandardFilters#replace_first | |
B
|
Liquid::StandardFilters#newline_to_br | |
B
|
Liquid::StandardFilters#remove_first | |
B
|
Liquid::StandardFilters#divided_by | |
B
|
Liquid::StandardFilters#capitalize | |
B
|
Liquid::StandardFilters#downcase | |
B
|
Liquid::Template.register_filter | |
B
|
Liquid::StandardFilters#truncate | |
B
|
Liquid::StandardFilters#reverse | |
B
|
Liquid::StandardFilters#prepend | |
B
|
Liquid::StandardFilters#replace | |
B
|
Liquid::StandardFilters#remove | |
B
|
Liquid::StandardFilters#upcase | |
B
|
Liquid::StandardFilters#append | |
B
|
Liquid::StandardFilters#split | |
B
|
Liquid::StandardFilters#first | |
B
|
Liquid::StandardFilters#minus | |
B
|
Liquid::StandardFilters#times | |
B
|
Liquid::StandardFilters#join | |
B
|
Liquid::StandardFilters#plus | |
B
|
Liquid::StandardFilters#sort | |
B
|
Liquid::StandardFilters#last | |
B
|
Liquid::StandardFilters#size | |
B
|
Liquid::Context#add_filters | |
B
|
Liquid::StandardFilters#map | |
B
|
Liquid::Drop#before_method | |
B
|
Liquid::Template.parse | |
B
|
Liquid::Context#merge | |
B
|
Liquid::Context#push | |
B
|
Liquid::Context#[]= |
Needs work | ||
---|---|---|
– |
Undocumented | ||
---|---|---|
U
|
Liquid::Template#render! | |
U
|
FalseClass | |
U
|
TrueClass | |
U
|
NilClass | |
U
|
Liquid::Block#assert_missing_delimitation! | |
Show 151 more ... | ||
U
|
Liquid::StandardFilters#escape | |
U
|
Liquid::Context#initialize | |
U
|
Liquid::I18n#translate | |
U
|
Liquid::Tag.parse | |
U
|
Liquid::Utils.slice_collection_using_each | |
U
|
Liquid::Variable#parse_filterargs | |
U
|
Liquid::Utils.slice_collection | |
U
|
Liquid::Context#handle_error | |
U
|
Liquid::StandardFilters | |
U
|
Liquid::Context#invoke | |
U
|
Module#liquid_methods | |
U
|
Liquid::LocalFileSystem#read_template_file | |
U
|
Liquid::Context#increment_used_resources | |
U
|
Liquid::Context#clear_instance_assigns | |
U
|
Liquid::Tag#parse_with_selected_parser | |
U
|
Liquid::StandardFilters#truncatewords | |
U
|
Liquid::StandardFilters#escape_once | |
U
|
Liquid::StandardFilters#strip_html | |
U
|
Liquid::LocalFileSystem#initialize | |
U
|
Liquid::Parser#variable_signature | |
U
|
Liquid::Template#resource_limits= | |
U
|
Liquid::Template#instance_assigns | |
U
|
Liquid::LocalFileSystem#full_path | |
U
|
Liquid::Template#resource_limits | |
U
|
Liquid::Context#rethrow_errors= | |
U
|
Liquid::StandardFilters#default | |
U
|
Liquid::Context#resource_limits | |
U
|
Liquid::StandardFilters#rstrip | |
U
|
Liquid::StandardFilters#lstrip | |
U
|
Liquid::StandardFilters#modulo | |
U
|
Liquid::Context#rethrow_errors | |
U
|
Liquid::StandardFilters#strip | |
U
|
Liquid::Template.file_system= | |
U
|
Liquid::Block#create_variable | |
U
|
Liquid::Variable#strict_parse | |
U
|
Liquid::Block#block_delimiter | |
U
|
Liquid::LocalFileSystem#root= | |
U
|
Liquid::Template.register_tag | |
U
|
Liquid::Template.file_system | |
U
|
Liquid::LocalFileSystem#root | |
U
|
Liquid::Interrupt#initialize | |
U
|
Liquid::Context#environments | |
U
|
Liquid::Variable#initialize | |
U
|
Liquid::Template.error_mode | |
U
|
Liquid::Variable#warnings= | |
U
|
Liquid::Variable#lax_parse | |
U
|
Liquid::Continue#interrupt | |
U
|
Liquid::Template#registers | |
U
|
Liquid::Variable#filters= | |
U
|
Liquid::Context#registers | |
U
|
Liquid::Parser#expression | |
U
|
Liquid::Variable#warnings | |
U
|
Liquid::Block#unknown_tag | |
U
|
Liquid::Interrupt#message | |
U
|
Liquid::Template#warnings | |
U
|
Liquid::Parser#initialize | |
U
|
Liquid::Block#block_name | |
U
|
Liquid::Context#strainer | |
U
|
Liquid::Lexer#initialize | |
U
|
Liquid::Variable#filters | |
U
|
Liquid::Template#assigns | |
U
|
Liquid::Variable#render | |
U
|
Liquid::Break#interrupt | |
U
|
Liquid::Parser#argument | |
U
|
Liquid::I18n#initialize | |
U
|
Liquid::Template#errors | |
U
|
Liquid::Lexer#tokenize | |
U
|
Liquid::Parser#consume | |
U
|
Liquid::Context#scopes | |
U
|
Liquid::Variable#name= | |
U
|
Liquid::Template#root= | |
U
|
Liquid::Drop#to_liquid | |
U
|
Liquid::Context#errors | |
U
|
Liquid::Tag#initialize | |
U
|
Liquid::Drop#context= | |
U
|
Liquid::Block#end_tag | |
U
|
Liquid::Template.tags | |
U
|
Liquid::Variable#name | |
U
|
Liquid::Template#root | |
U
|
Liquid::ElseCondition | |
U
|
Liquid::Tag#warnings | |
U
|
Liquid::Tag#nodelist | |
U
|
Liquid::Drop#inspect | |
U
|
Liquid::Tag#options= | |
U
|
Liquid::I18n#locale | |
U
|
Liquid::Parser#jump | |
U
|
Liquid::Parser#look | |
U
|
Liquid::Tag#options | |
U
|
Liquid::Context#[] | |
U
|
Liquid::Tag#render | |
U
|
Liquid::I18n#path | |
U
|
Liquid::Tag#parse | |
U
|
Liquid::Drop#to_s | |
U
|
Liquid::Ifchanged | |
U
|
Liquid::Document | |
U
|
Liquid::Tag#name | |
U
|
Liquid::TableRow | |
U
|
Liquid::Comment | |
U
|
Liquid::Parser | |
U
|
Liquid::Utils | |
U
|
Liquid::Block | |
U
|
Liquid::Lexer | |
U
|
Liquid::Case | |
U
|
Liquid::I18n | |
U
|
Liquid::Raw | |
U
|
Liquid::Tag | |
U
|
Liquid::Block#render_all | |
U
|
Liquid::For#strict_parse | |
U
|
Liquid::For#lax_parse | |
U
|
Liquid::Strainer::@@strainer_class_cache | |
U
|
Liquid::Strainer::@@known_methods | |
U
|
Liquid::Strainer::@@known_filters | |
U
|
Liquid::Template::@@file_system | |
U
|
Liquid::Condition::@@operators | |
U
|
Liquid::ElseCondition#evaluate | |
U
|
Liquid::Increment#initialize | |
U
|
Liquid::Decrement#initialize | |
U
|
Liquid::Comment#unknown_tag | |
U
|
Liquid::TableRow#initialize | |
U
|
Liquid::Strainer::@@filters | |
U
|
Liquid::Include#initialize | |
U
|
Liquid::Capture#initialize | |
U
|
Liquid::Assign#initialize | |
U
|
Liquid::Decrement#render | |
U
|
Liquid::Increment#render | |
U
|
Liquid::Case#unknown_tag | |
U
|
Liquid::Ifchanged#render | |
U
|
Liquid::Cycle#initialize | |
U
|
Liquid::For#unknown_tag | |
U
|
Liquid::TableRow#render | |
U
|
Liquid::Case#initialize | |
U
|
Liquid::Capture#render | |
U
|
Liquid::Document.parse | |
U
|
Liquid::If#unknown_tag | |
U
|
Liquid::Comment#render | |
U
|
Liquid::Include#render | |
U
|
Liquid::For#initialize | |
U
|
Liquid::Case#nodelist | |
U
|
Liquid::Assign#render | |
U
|
Liquid::Include#parse | |
U
|
Liquid::If#initialize | |
U
|
Liquid::Unless#render | |
U
|
Liquid::Block#render | |
U
|
Liquid::For#nodelist | |
U
|
Liquid::Cycle#render | |
U
|
Liquid::Block#parse | |
U
|
Liquid::Case#render | |
U
|
Liquid::If#nodelist | |
U
|
Liquid::For#render | |
U
|
Liquid::Raw#parse | |
U
|
Liquid::If#render |
This page is for Shopify/liquid
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)
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.