GithubHelp home page GithubHelp logo

Comments (5)

DavidAnson avatar DavidAnson commented on July 1, 2024 1

What do you think is wrong here?

The documentation for MD026 explicitly calls out that it will trigger for ? and !:
https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-header

If you do not like this rule, it can be disabled completely - or you can edit the list of characters it looks for (again, see documentation above).

from markdownlint.

DavidAnson avatar DavidAnson commented on July 1, 2024 1

Fair enough. :) For what it's worth, this rule came from the Ruby implementation. I'll admit it's not my absolute favorite rule, but I think it's a good guideline in general, it's easy to turn off if you don't want it, and it's easy to customize when needed. I'm not inclined to break compatibility with the Ruby implementation over something like this, so unless you find that the rule is behaving wrongly, I will recommend turning it off. Sorry for the inconvenience!

from markdownlint.

wbolster avatar wbolster commented on July 1, 2024

what i think is wrong here is that the defaults are not sensible enough. :)

having a question mark at the end of a header is quite common (e.g. faqs), and requiring explicit configuration for it seems backwards to me.

from markdownlint.

wbolster avatar wbolster commented on July 1, 2024

yeah i understand you took the rules from another project (unsure why there are 2 implementations though), but i was not aware that you aim for keeping those rules unchanged, even when they do not make sense as defaults.

thanks for the explanation.

from markdownlint.

petk avatar petk commented on July 1, 2024

Hello, worth noting, that headings in writings can include question marks an exclamation marks. Yes, one of the more strange settings.

from markdownlint.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.