Skip to content

Commit

Permalink
rename todotxtmac.rb to todotxt.rb
Browse files Browse the repository at this point in the history 
to conform with naming conventions: trailing "Mac" should
be removed
  • Loading branch information
@rolandwalker
rolandwalker committed Nov 25, 2014
1 parent 6926dac commit b994bd7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Casks/todotxtmac.rb → Casks/todotxt.rb
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cask :v1 => 'todotxtmac' do
cask :v1 => 'todotxt' do
version '1.2.4'
sha256 '368010bec057387bdc6ee9cef4646f90d8eb1af8e1b4ec1666045e7e2166db4a'

Expand Down

4 comments on commit b994bd7

@thorink
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

naming conventions also states an exception: "…when the software is not a port, but "Mac" is an inseparable part of the name, without which the name would not make sense…".

When i added this cask i read the naming conventions and thought about it. There is the cross platform cli version of it, called todo.txt (todo-txt in homebrew). Then there are some guis for it like "Todotxt.net", "Todour", "QTodoTxt", "jdotxt" and others. Since this is not the official gui for the mac, there are others, and to avoid confusion with the command line tool, I thought it would be worth to leave the 'mac' on the name.

@thorink
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I talked to the author and he agrees. Here is what he said [https://github.com/mjdescy/TodoTxtMac/issues/39#issuecomment-64806278].

@vitorgalvao
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear (and there is no way to say this without it sounding bad), the author’s opinion is irrelevant to this matter. Those rules exist for very clear purposes (clear to maintainers, but admittedly not yet documented, which should happen soon) and those are more important that the author’s wishes. Naturally we’ll try to accommodate them when possible and it makes sense, but after a certain point having predictability in the system is way more important (we know how it was when there was no rules: considerably worse).

Having said that, I do agree that this seems like an acceptable case to have “mac” in the name; you both made convincing points.

I’ll defer this to @rolandwalker, though. Since he was the one to change it, he might have a different opinion.

@rolandwalker
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for reaching out to the author.

We have reasons for applying these rules, which are laid out in more detail here and in the changes in #7643.

In short, what we are calling the "name" is not the "name" but the shortest unique token. This token never captures the fine points of branding, because it must answer to other constraints.

To capture the author's full and exact orthography, we have also added tags :name which accepts an unconstrained UTF-8 string. tags :name should be added to this Cask. (In my opinion, it should be added to every Cask, though we are just getting started with that.)

Please sign in to comment.