From f5c4e6b8dad8ceec2a5317ddaa679cd4c96d2678 Mon Sep 17 00:00:00 2001 From: Krzysztof Kowalczyk Date: Thu, 25 Jan 2018 13:15:22 -0800 Subject: [PATCH] tweak comments --- .travis.yml | 5 ++--- LICENSE.txt | 58 +++++++++++++++++++++++++++-------------------------- markdown.go | 8 +++----- 3 files changed, 35 insertions(+), 36 deletions(-) diff --git a/.travis.yml b/.travis.yml index a4eb257..b7d4984 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,13 +1,12 @@ # Travis CI (http://travis-ci.org/) is a continuous integration service for # open source projects. This file configures it to run unit tests for -# blackfriday. +# markdown. language: go go: - 1.5 - - 1.6 - - 1.7 + - 1.9 install: - go get -d -t -v ./... diff --git a/LICENSE.txt b/LICENSE.txt index 2885af3..6880461 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,29 +1,31 @@ -Blackfriday is distributed under the Simplified BSD License: +Markdown is distributed under the Simplified BSD License: -> Copyright © 2011 Russ Ross -> All rights reserved. -> -> Redistribution and use in source and binary forms, with or without -> modification, are permitted provided that the following conditions -> are met: -> -> 1. Redistributions of source code must retain the above copyright -> notice, this list of conditions and the following disclaimer. -> -> 2. Redistributions in binary form must reproduce the above -> copyright notice, this list of conditions and the following -> disclaimer in the documentation and/or other materials provided with -> the distribution. -> -> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -> "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS -> FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE -> COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, -> INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, -> BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -> LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -> CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT -> LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN -> ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -> POSSIBILITY OF SUCH DAMAGE. +Copyright © 2011 Russ Ross +Copyright © 2018 Krzysztof Kowalczyk +Copyright © 2018 Authors +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided with + the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. diff --git a/markdown.go b/markdown.go index 5ea5329..9f94f83 100644 --- a/markdown.go +++ b/markdown.go @@ -23,8 +23,7 @@ import ( // CompletePage flag is on. const Version = "2.0" -// Extensions is a bitwise or'ed collection of enabled Blackfriday's -// extensions. +// Extensions is a bitfield of enabled extensions. type Extensions int // These are the supported markdown parsing extensions. @@ -321,15 +320,14 @@ func WithRenderer(r Renderer) Option { } } -// WithExtensions allows you to pick some of the many extensions provided by -// Blackfriday. You can bitwise OR them. +// WithExtensions allows you to enable extensions func WithExtensions(e Extensions) Option { return func(p *Markdown) { p.extensions = e } } -// WithNoExtensions turns off all extensions and custom behavior. +// WithNoExtensions turns off all extensions func WithNoExtensions() Option { return func(p *Markdown) { p.extensions = NoExtensions