GithubHelp home page GithubHelp logo

Comments (5)

wooorm avatar wooorm commented on June 15, 2024 3

I personally prefer British spelling, and use that in documentation. I do use US spelling for code though. Above all consistency is most important. The reason for this API case is that this library was originally authored by a UK citizen.

I think behavior would be better here. Although Iā€™m very much against unneeded breaking changes, we can:

  • Update the docs to use behavior
  • Update the code to use behavior but fall back to behaviour if behavior is not given
  • Cut a minor release

from remark-autolink-headings.

missmatsuko avatar missmatsuko commented on June 15, 2024 1

Agreed! I can work on this, if you'd like.

Should we also add some kind of warning when behaviour is used?
If so, is console.warn(someMessage) sufficient? I don't know what's standard.

from remark-autolink-headings.

ChristianMurphy avatar ChristianMurphy commented on June 15, 2024 1

Sounds good, Node does something similar (docs and source)
console.warn looks like a nice, light weight approach šŸ‘ (browser compatibility)

from remark-autolink-headings.

Murderlon avatar Murderlon commented on June 15, 2024

As far as I know the remark ecosystem leans towards American spelling but at this point I don't think it's worth a breaking change on its own.

from remark-autolink-headings.

wooorm avatar wooorm commented on June 15, 2024

Console.warn is nice enough but I'd still be slightly annoyed by those appearing from a minor update?
I would Def be for a comment that says something like 'remove next major'.

But I'm up for what everyone else things, no strong feelings!

from remark-autolink-headings.

Related Issues (13)

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.