Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How do you write neovim? #149

Closed
commonquail opened this issue Feb 25, 2014 · 22 comments
Closed

How do you write neovim? #149

commonquail opened this issue Feb 25, 2014 · 22 comments

Comments

@commonquail
Copy link

The name of the project has been variously written "Neovim", "NeoVim", "neovim", and a few other ways in different places. There should be a single correct way to write the name and it should address how to properly capitalise the name depending on its position in a sentence and whether it stands alone or not.

The README consistently uses "neovim", with capital N only when used as the first word. This is consistent with the GitHub organisation name ("Neovim") but not the repo name or waffle.io's integration (though it looks like waffle.io just uses the repo name). #123 prompted me to write this because it's the first document I notice that isn't internally consistent.

This may seem like a petty issue but inconsistency looks unprofessional and shouldn't be allowed in public facing material. I'm specifically thinking of the website but it applies to various documents, too, and the issue belongs here because, well, it's the name of the project.

@tarruda should probably just make this call.

Note that this doesn't apply to the binary for practical reasons, but, say, a manpage, should use either the binary name or the proper project name. The decision may or may not have implications for #43.

@tbelaire
Copy link
Contributor

Thanks for bringing this up, I agree that we should have one way to do it.

@ghost
Copy link

ghost commented Feb 26, 2014

I think its best to list it like a normal proper noun, Neovim.

Using camelcase or any weird case scheme is unnatural, why can't we use the
normal English? Unless it's a generic, like grep which is just a type of
tool not a specific implementation it seems weird to not capitalize in a
sentence.
On Feb 25, 2014 6:19 PM, "commonquail" notifications@github.com wrote:

The name of the project has been variously written "Neovim", "NeoVim",
"neovim", and a few other ways in different places. There should be a
single correct way to write the name and it should address how to properly
capitalise the name depending on its position in a sentence and whether it
stands alone or not.

The README consistently uses "neovim", with capital N only when used as
the first word. This is consistent with the GitHub organisation name
("Neovim") but not the repo name or waffle.io's integration (though it
looks like waffle.io just uses the repo name). #123https://github.com/neovim/neovim/pull/123prompted me to write this because it's the first document I notice that
isn't internally consistent.

This may seem like a petty issue but inconsistency looks unprofessional
and shouldn't be allowed in public facing material. I'm specifically
thinking of the website but it applies to various documents, too, and the
issue belongs here because, well, it's the name of the project.

@tarruda https://github.com/tarruda should probably just make this call.

Note that this doesn't apply to the binary for practical reasons, but,
say, a manpage, should use either the binary name or the proper project
name. The decision may or may not have implications for #43#43
.

Reply to this email directly or view it on GitHubhttps://github.com//issues/149
.

@ilAYAli
Copy link
Contributor

ilAYAli commented Feb 26, 2014

The inconsistent naming is even more noticeable with the following changes:

commit: 9db0fc3
renamed vim to nvim

commit:79321c62d504674d26de1d70a4832cfad7fb976e
renamed .vimrc to .neovim

@scott-linder
Copy link

@badeip agreed, see #50 for the discussion on the name of the binary. Perhaps we should use the lower-case, long form version (neovim) in all file-system based names, and decide on a consistent name for prose (I personally vote for NeoVim since it is really a composition of two proper nouns).

I also think @tarruda should make the call and we should stick to it.

@aktau
Copy link
Contributor

aktau commented Feb 26, 2014

True, I vote for consistency all over the place, i.e.: neovim everywhere.

@tarruda
Copy link
Member

tarruda commented Feb 27, 2014

Lets treat this like any other word: 'Neovim' when at the beginning of a sentence and 'neovim' in all other cases.

@ghost
Copy link

ghost commented Feb 27, 2014

But isn't neovim a proper noun?
On Feb 26, 2014 8:18 PM, "Thiago de Arruda" notifications@github.com
wrote:

Lets treat this like any other word: 'Neovim' when at the beginning of a
sentence and 'neovim' in all other cases.

Reply to this email directly or view it on GitHubhttps://github.com//issues/149#issuecomment-36199617
.

@tssm
Copy link

tssm commented Feb 27, 2014

+1 for Neovim (as proper noun) and neovim in all file-system based names.

@Olivia5k
Copy link
Contributor

+1 for consistency; neovim everywhere. I was always bothered that vim seemed to be ViM in some places.

@ashleyh
Copy link
Contributor

ashleyh commented Feb 27, 2014

My preference would be 'neovim'.

Side note: a pet hate of mine is the use of VIsual in the code.

@ku1ik
Copy link

ku1ik commented Feb 27, 2014

+1 for Neovim (as proper noun) and neovim in all file-system based names.
👍

@aktau
Copy link
Contributor

aktau commented Feb 27, 2014

Side note: a pet hate of mine is the use of VIsual in the code.

Oh god yes, makes everything seems so untidy... must be some sort of OCD of mine. Perhaps another issue for another time.

@dvidsilva
Copy link

I think I speak for many when I say is better not to have filenames or folders that start with a capital letter. So it's better to use .neovim or neovim consistently.

@commonquail
Copy link
Author

@dvidsilva: that is precisely the reason behind my last paragraph. The fact that lowercase is expected in the terminal should not be a factor in this decision. It may be the decision, but the reasons should be something else.

My preference is the same as @taecilla's , for the simple reason that, grammatically, it is far and away the simplest choice. However, we will never all agree on this, and in the interest of getting things done I am perfectly fine with letting @tarruda make an executive decision. The main thing I want to achieve is avoiding the situation that @ashleyh described.

@dvidsilva
Copy link

Ah, in totally accordance, apparently is the most voted decision, I meant consistently across the code and filesystem, in marketing, or websites, or techcrunch they can be free to case it however it makes more sense grammatically. ||30/1|/|

@dvidsilva
Copy link

Github needs a 'like' button to make the +1 comments unnecessary. Or the ability to comment under comments.

@tarruda
Copy link
Member

tarruda commented Feb 28, 2014

ok it makes more sense to use it as a proper noun, although I can't guarantee I will always follow that rule :)

@waldyrious
Copy link

Github needs a 'like' button to make the +1 comments unnecessary. Or the ability to comment under comments.

+1 ;)

@tarruda
Copy link
Member

tarruda commented Mar 3, 2014

It's decided, neovim is written like a proper noun

@tarruda tarruda closed this as completed Mar 3, 2014
@Gaelan
Copy link
Contributor

Gaelan commented Mar 4, 2014

neovim

Neovim

@roryokane
Copy link

Here is my attempt at a miniature style guide, to help other people understand the rules, and to clarify that I’m understanding the rules right. If any of this is wrong, correct me. I may transfer this guide to the wiki or other documentation later.

The name of the project is “Neovim”.

“Neovim” is written like a proper noun. The name is written “Neovim” (without the quotes), no matter where in a sentence it is. Examples of correct usage:

  • Neovim is a project that seeks to aggressively refactor Vim source code.
  • I think I’ll contribute to Neovim.
  • Should I use Neovim or Emacs?

Some incorrect capitalizations of “Neovim”:

  • neovim
  • NeoVim

This style guide applies to the name of the software, as well as the name of the project to develop the software. It does not necessarily apply to the names of Neovim’s binary executable or of folders within its source code.

@commonquail
Copy link
Author

Correct.

justinmk referenced this issue in ZyX-I/neovim Aug 18, 2015
For use in viminfo→shada converters, plugins that allow editing ShaDa files or 
any other software which generates ShaDa files for whatever purpose.
dwb pushed a commit to dwb/neovim that referenced this issue Feb 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests