GithubHelp home page GithubHelp logo

New rule: language style about doc-linter-rules HOT 3 OPEN

Elchi3 avatar Elchi3 commented on July 2, 2024
New rule: language style

from doc-linter-rules.

Comments (3)

SebastianZ avatar SebastianZ commented on July 2, 2024

For reference, in the closed issue I mentioned some more cases related to the style guide:

  • Latin abbreviations should be correctly abbreviated and used.
  • Use sentence-style capitalization for keyboard shortcuts.
  • Use proper hyphenation for "email", "re-" and "co-".
  • Correctly format dates and numbers. (Though the rule about setting a comma only on five-digit numbers looks strange to me.)

Sebastian

from doc-linter-rules.

MatonAnthony avatar MatonAnthony commented on July 2, 2024

Hi @SebastianZ,

Latin abbreviations should be correctly abbreviated and used.

I can make the full term triggers an ERROR and ask for the abbreviated but I don't have any way to check if it's properly used.

Use sentence-style capitalization for keyboard shortcuts.
Use proper hyphenation for "email", "re-" and "co-".

Ok, I'll implement those two in the opened PR before merging.

Correctly format dates and numbers. (Though the rule about setting a comma only on five-digit numbers looks strange to me.)

Parsing Dates and especially more likely to be formatted in a ton of different ways seems complicated to me.

from doc-linter-rules.

SebastianZ avatar SebastianZ commented on July 2, 2024

Latin abbreviations should be correctly abbreviated and used.

I can make the full term triggers an ERROR and ask for the abbreviated but I don't have any way to check if it's properly used.

Point here is that if abbreviations are used, they must be used correctly. Writers are not forced to used them, though.

So, for example, "e.g." must be written with dots but no space between them, followed by a comma and expressions using them need to be surrounded by parentheses.
Having said that, I wonder why the style guide says that separating them by comma is wrong. So, personally I'd not mark that as an error.

Correctly format dates and numbers. (Though the rule about setting a comma only on five-digit numbers looks strange to me.)

Parsing Dates and especially more likely to be formatted in a ton of different ways seems complicated to me.

You're right about that, but we may restrict the recognition to the ones mentioned in the style guide, which should be the most common erroneous writings. For example, dates formatted like "February 24th, 2006" are easily recognized via /[a-z]{3,}\s+\d{1,2}(?:st|nd|rd|th),?\s+\d{4}/. But, of course, the complete check might get a bit complicated.

Sebastian

from doc-linter-rules.

Related Issues (15)

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.