diff --git a/docs/devnotes.htm b/docs/devnotes.htm index 3e3a722a..8ff0857e 100644 --- a/docs/devnotes.htm +++ b/docs/devnotes.htm @@ -5,11 +5,11 @@ weewx: Developer's Notes - + - + @@ -256,6 +256,9 @@ next_ts = int(time.mktime(next_dt.timetuple())) extraneous "changed lines," trying to find the important stuff. +

If you are working with a file where the formatting is so ragged that you really must do + a reformat, then do it as a separate commit. This allows the formatting changes to be clearly + distinguished from more functional changes.

When invoking functions or instantiating classes, use the fully qualified name. Don't do this:

from datetime import dt
@@ -264,6 +267,25 @@ now = dt()
import datetime
 now = datetime.datetime()
+

Tools

+

Python

+

Eclipse, with the + PyDev Python extension, is highly recommended. + It's free, easy to customize and extremely powerful.

+

JetBrain's PyCharm is also good, + but it costs money. Where it really shines is if you use a framework + such as Django, or Backbone, but weeWX does not use any of these, so there is no real need + for PyCharm's extra functionality when working with weeWX.

+ +

HTML and Javascript

+

For HTML, JetBrain's WebStorm + used to be the undisputed master. However, in recent years, I've found + that Eclipse's "Web Development Tools" + to be its equal, or even better, particularly when working with + long HTML documents like the Customizing Guide.

+

However, if you are working with Javascript, particularly if you're using a framework + like NodeJS or ExpressJS, there is no contest: WebStorm is the way to go.

+

Glossary

This is a glossary of terminology used throughout the code.