The document discusses the importance of code analysis and style guidelines for maintaining consistent and readable code. It provides examples of inconsistencies that can arise without standards and recommends using tools like plone.recipe.codeanalysis to enforce guidelines. Style guides help reduce cognitive load on developers by standardizing formatting and structures.

1. Code analysis for a better future

2. Gil Forcada
Head developer at der Freitag

4. Few questions:
pep8?
pep257?
internal guidelines?
enforcing them?
p.r.codeanalysis?
p.api style guide?
hacking?

5. Why follow standards?

6. "Mars Climate Orbiter 2" by NASA/JPL/Corby Waste - Licensed under Public domain via
Wikimedia Commons

7. It is not clear which coding style is used for various
shell scripts present in this repository.
Having some clear guidelines, like how many
characters are used for indentation, if then appears in
the same line as if, and such will be helpful to create
consistent code easier to read by humans.
- developer trying to start contributing on a project (emphasis mine)

8. BREAKING NEWS

9. FWT meeting notes from 2013-03-05
...
...
...
...
...
We approved the style guide used by plone.api as
the official code style guide for Plone core.
http://plone.293351.n2.nabble.com/Framework-team-meeting-2013-03-05-td7563639.html

10. Examples / Ideas / Thoughts

11. Sanetizing Plone Views
https://gist.github.com/regebro/5326178
@April 12 2013

13. Consistency MaTterS, size not

14. EXAMPLE OF INCONSISTENT FILE

15. 100 devs, 1 file

16. Written once, read forever

17. EXAMPLE OF A DIFF WITH:
Trailing whitespaces, extra empty lines, different
cases, mixing string quotings, different
indentation, changing parts that are not related to
the code, typos here and there...

18. Commit messages / history log

19. http://stackoverflow.com/questions/1057564

20. Don't lie

21. Add grok.queryAnnotation() from
grokcore.annotation
+from grokcore.annotation import queryAnnotation
Actually...
Remove code on buildout.cfg
New version of bootstrap.py
https://github.com/zopefoundation/grok/commit/0e4ecf6e3f2531f90f7e7e498
97d1b9439802f29

22. But please...

24. Cognitive load
Is the load related to the executive control of working memory
(WM). Theories contend that during complex learning activities the
amount of information and interactions that must be processed
simultaneously can either underload or overload the finite amount
of working memory one possesses. All elements must be processed
before meaningful learning can continue.
Wikipedia (quoting book "Cognitive Load Theory: Instructional Implications of
the Interaction between Information Structures and Cognitive Architecture".)

25. plone.recipe.codeanalysis to the rescue

26. .py
.zcml
.xml
.pt
.js
.css
.rst
package structure
testing approach
...

27. FUTURE

28. Openspace anyone?

29. THANKS!