cygnusnow / ulipad

Automatically exported from code.google.com/p/ulipad
0 stars 0 forks source link

Two last typo fixes... Please fix this quickly #122

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
Limodou, I must tell you to fix one little thing in the Check Syntax
window. If you have the option 'Check syntax for PEP8-style at python
program run' enabled in the preferences, then you automatically get
warnings in the Check Syntax window if your source code does not match the
PEP8 coding style. And the typo I found is this...

- 'Check Syntax' window: checkbox label 'Auto PEP8 style check with syntax
check' --> 'Check syntax for PEP8-style at python program run'

This checkbox label should be written exactly the same as it is in the
preferences. This really needs to be fixed so that it is consistent.

- 'Check Syntax' window: If the syntax checker founds something that
doesn't match the PEP8 style, then the 'Check Syntax' window shows up and
displays where the PEP8-style inconsistency was found. 3 columns appear:
'Filename', 'LineNo', and 'Description'. These 3 columns doesn't have the
correct labels. Please fix the following labels like this...

a) 'Filename' --> 'File path'
Please note that the whole path to the file is displayed, so the label
should be 'File path'.

b) 'LineNo' --> 'Line number'
The label 'LineNo' is just ugly. Please fix it to 'Line number'. And if
this looks ugly because it is too long, then you can write the label as
'Line no.'.

c) 'Description': This label is okay.

Please fix these things. I decided to report a typo or a bug in UliPad if I
find it. Please fix this as soon as you can. Thank you.

Original issue reported on code.google.com by wxPytho...@gmail.com on 24 Jul 2008 at 8:38

GoogleCodeExporter commented 9 years ago
Please fix one help string as well...

- Document > Autoindent: 'Toggles the auto-indent feature of the active 
document.'
--> 'Toggles the autoindent feature of the current document.'

Please note that the word 'auto-indent' was fixed to 'autoindent'.

- File > Recent Files...: 'Opens last documents you closed.' --> 'Opens a list 
of the
last documents you closed.'

By clicking on this menu item, you don't directly open the last documents you 
closed.
You get a list of the last opened documents. Please fix this help string.

Now I must tell you something... In the main menu 'File', you use the word 
'current'
(like there are help strings with the words 'current document'), but in other 
main
menus you use the word 'active' (like there are help strings with the words 
'active
document'). Please decide which one you will use and make it consistent for all 
the
help strings. I suggest that you use the word 'current'.

And now you have to fix all help strings that have the word 'active' to the word
'current'. As Guido van Rossum (the creator of Python) said in PEP8: 'A Foolish
Consistency is the Hobgoblin of Little Minds'. He basically said that 
inconsistency
(or foolish consistency) is bad. So please make the help strings consistent. 
Thank you.

Original comment by wxPytho...@gmail.com on 24 Jul 2008 at 9:46

GoogleCodeExporter commented 9 years ago
[deleted comment]
GoogleCodeExporter commented 9 years ago
For Recent Files I just copied them from EditPlus, so I want to keep up with 
EditPlus.

Original comment by limo...@gmail.com on 24 Jul 2008 at 1:35

GoogleCodeExporter commented 9 years ago
"And now you have to fix all help strings that have the word 'active' to the 
word
'current'. As Guido van Rossum (the creator of Python) said in PEP8: 'A Foolish
Consistency is the Hobgoblin of Little Minds'. He basically said that 
inconsistency
(or foolish consistency) is bad. So please make the help strings consistent. 
Thank 
you."

First of all, let's put that saying in it's proper context. It's from Emerson, 
not 
Guido:

A foolish consistency is the hobgoblin of little minds, adored by little 
statesmen 
and philosophers and divines. With consistency a great soul has simply nothing 
to 
do. He may as well concern himself with his shadow on the wall. Speak what you 
think 
now in hard words, and to-morrow speak what to-morrow thinks in hard words 
again, 
though it contradict every thing you said to-day. — 'Ah, so you shall be sure 
to be 
misunderstood.' — Is it so bad, then, to be misunderstood? Pythagoras was 
misunderstood, and Socrates, and Jesus, and Luther, and Copernicus, and 
Galileo, and 
Newton, and every pure and wise spirit that ever took flesh. To be great is to 
be 
misunderstood. 

http://www.emersoncentral.com/selfreliance.htm

Now as to PEP 8. You should have given the whole context, which is:

==============================================================
A Foolish Consistency is the Hobgoblin of Little Minds

    One of Guido's key insights is that code is read much more often than it
    is written.  The guidelines provided here are intended to improve the
    readability of code and make it consistent across the wide spectrum of
    Python code.  As PEP 20 [6] says, "Readability counts".

    A style guide is about consistency.  Consistency with this style guide is
    important.  Consistency within a project is more important. Consistency
    within one module or function is most important.

    BUT MOST IMPORTANTLY: KNOW WHEN TO BE INCONSISTENT -- SOMETIMES THE STYLE
    GUIDE JUST DOESN'T APPLY.  WHEN IN DOUBT, USE YOUR BEST JUDGMENT.  LOOK
    AT OTHER EXAMPLES AND DECIDE WHAT LOOKS BEST.  And don't hesitate to ask!

    Two good reasons to break a particular rule:

    (1) When applying the rule would make the code less readable, even for
        someone who is used to reading code that follows the rules.

    (2) To be consistent with surrounding code that also breaks it (maybe for
        historic reasons) -- although this is also an opportunity to clean up
        someone else's mess (in true XP style).

     (The emphasis is mine)

Original comment by rdmoo...@gmail.com on 24 Jul 2008 at 1:35

GoogleCodeExporter commented 9 years ago
Limodou, you have made a typo in one of the help strings. Allow me to correct 
you.

- File > Save As...: 'Saves an opened document to a specified file name.' --> 
'Saves
an opened document to a specified filename.'

Please note that 'file name' was corrected to 'filename'. Maybe it was your 
typo or
maybe it was a typo in the application that you've taken the help string. 
Anyhow,
this needs to be fixed. The help string of the menu item 'Save' has the word
'filename' correctly written. Please fix this help string word for the menu item
'Save As...'. Thank you.

- File > Recent Files...: 'Opens last documents you closed.' --> 'Opens a list 
of the
last opened files.'

I must argue here that this help string is not good. Firstly, it is broken 
English
because it lacks a 'the' before the word 'last'; and secondly, it is not good 
to have
a help string that communicates with the user. Help strings are formal and do 
not
address the user. The 'you closed' part of the help string is not okay. Please 
change
this help string to the one proposed by me. Your help string indicates that the 
last
documents that were closed by the user will be immediately opened after this 
menu
item is going to be clicked, but that is not true. The truth is that a *list* of
recent files is going to be displayed after this menu item is clicked. Please 
express
yourself correctly here. I really must insist that you change this help string 
as
proposed by me. I just want to make UliPad better. And in this case I think I 
have a
better solution than you. All I want is for UliPad to be the best source code 
editor.
Let other editors look up to UliPad's help strings, not vice versa. Limodou, I 
really
want this fix to be made. Please fix this. Thank you.

Original comment by wxPytho...@gmail.com on 24 Jul 2008 at 9:13

GoogleCodeExporter commented 9 years ago
I almost forgot to tell you... Please make the middle column in the window 
'Check
Syntax' (which is labeled 'Line number') a little wider, so that the user 
doesn't
need to resize it to have the whole label displayed. Thank you.

Original comment by wxPytho...@gmail.com on 25 Jul 2008 at 12:12

GoogleCodeExporter commented 9 years ago
For help string I just copied from EditPlus, so it's not made by me. I want to 
keep
with it. Thanks.

Original comment by limo...@gmail.com on 1 Aug 2008 at 1:20

GoogleCodeExporter commented 9 years ago
May I assume I am still part of this process of improving Ulipad?

If so...

"- File > Save As...: 'Saves an opened document to a specified file name.' --> 
'Saves
an opened document to a specified filename.'"

I do not see 'Saves an opened document to a specified file name' in r436. It's 
not 
in the menu or in the dialog. Where is it?

"- File > Recent Files...: 'Opens last documents you closed.' --> 'Opens a list 
of 
the last opened files.'"

Similarly, I do not see 'Opens last documents you closed.' In r436, there is 
only "Recent Documents...". Selecting this opens the handy list. Nothing else.

Also, 'Opens last documents you closed.' is NOT broken English, in this 
context, any 
more than "Previous Marker" in  Search -> Previous Marker  is broken English. 

I do agree, however, that the use of 'you' is inappropriate.

Original comment by rdmoo...@gmail.com on 1 Aug 2008 at 10:32

GoogleCodeExporter commented 9 years ago
Hello, Dick. I was refering to the help strings. Help string is a piece of text 
that
you see in the status bar if you hover your mouse pointer over a menu item that 
has a
help string implemented.

Limodou, please fix the string about which Dick and I both agree that it is
inappropriate:

- File > Recent Files...: 'Opens last documents you closed.' --> 'Opens a list 
of the
last opened files.'

Please fix this... Also, please consider or making UliPad 4.0 available in the
"Download" section of UliPad's website. We would all like to use UliPad 4.0. 
People
have to install Python and wxPython and then get the SVN version of UliPad to 
use
UliPad 4.0. Please compile the latest SVN of UliPad and create UliPad 4.0. 
Thanks.

Original comment by wxPytho...@gmail.com on 4 Aug 2008 at 10:17

GoogleCodeExporter commented 9 years ago
"Hello, Dick. I was refering to the help strings. Help string is a piece of 
text that
you see in the status bar if you hover your mouse pointer over a menu item that 
has a
help string implemented."

Ah, I see. I hadn't noticed those before.

Also I join in urging the release of 4.0.

Original comment by rdmoo...@gmail.com on 4 Aug 2008 at 10:35

GoogleCodeExporter commented 9 years ago
is it ok to copy text from EditPlus at all? It is not opensource and not free..

Original comment by phyo.arkarlwin on 26 Sep 2008 at 3:07

GoogleCodeExporter commented 9 years ago
I think it's not the code but caption text, and I just don't want to make spell
mistakes and keep up the convention with popular editor. 

Original comment by limo...@gmail.com on 27 Sep 2008 at 12:58

GoogleCodeExporter commented 9 years ago

Original comment by limo...@gmail.com on 24 Oct 2008 at 4:38