summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorDouwe Maan <douwe@selenight.nl>2017-01-16 18:11:15 -0500
committerDouwe Maan <douwe@selenight.nl>2017-01-16 18:11:15 -0500
commitbc3448fc48a289342948ec155fa9c7f2d49ca2bd (patch)
tree13f96b866d4d285b16784b40a665802e41bb8c31 /lib
parent37cabebe1661ab09eec6dfb74b7b09bc03e5f454 (diff)
downloadgitlab-ce-bc3448fc48a289342948ec155fa9c7f2d49ca2bd.tar.gz
Improve spec
Diffstat (limited to 'lib')
-rw-r--r--lib/banzai/pipeline/gfm_pipeline.rb7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/banzai/pipeline/gfm_pipeline.rb b/lib/banzai/pipeline/gfm_pipeline.rb
index 09038d38b1f..7b652aa79ec 100644
--- a/lib/banzai/pipeline/gfm_pipeline.rb
+++ b/lib/banzai/pipeline/gfm_pipeline.rb
@@ -1,9 +1,10 @@
module Banzai
module Pipeline
class GfmPipeline < BasePipeline
- # Every filter should have an entry in app/assets/javascripts/copy_as_gfm.js.es6,
- # in reverse order.
- # Should have test coverage in spec/features/copy_as_gfm_spec.rb.
+ # These filters convert GitLab Flavored Markdown (GFM) to HTML.
+ # The handlers defined in app/assets/javascripts/copy_as_gfm.js.es6 consequently convert that same HTML to GFM to be copied to the clipboard.
+ # Every filter that generates HTML from GFM should have a handler in app/assets/javascripts/copy_as_gfm.js.es6, in reverse order.
+ # The GFM-to-HTML-to-GFM cycle is tested in spec/features/copy_as_gfm_spec.rb.
def self.filters
@filters ||= FilterArray[
Filter::SyntaxHighlightFilter,