Skip to content

Commit 413139d

Browse files
authored
Update CONTRIBUTING.md
1 parent 0ff4b6e commit 413139d

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ Beyond the above rules, we use [Pep 8](https://www.python.org/dev/peps/pep-0008)
3131
- I have set `--max-line-length 100`, not 79.
3232
- You don't need two spaces after a sentence-ending period.
3333
- Strunk and White is [not a good guide for English](http://chronicle.com/article/50-Years-of-Stupid-Grammar/25497).
34-
- I prefer more concise docstrings; I don't follow [Pep 257](https://www.python.org/dev/peps/pep-0257/).
34+
- I prefer more concise docstrings; I don't follow [Pep 257](https://www.python.org/dev/peps/pep-0257/). In most cases,
35+
a one-line docstring suffices. It is rarely necessary to list what each argument does; the name of the argument usually is enough.
3536
- Not all constants have to be UPPERCASE.
3637
- At some point I may add [Pep 484](https://www.python.org/dev/peps/pep-0484/) type annotations, but I think I'll hold off for now;
3738
I want to get more experience with them, and some people may still be in Python 3.4.
@@ -40,7 +41,7 @@ Beyond the above rules, we use [Pep 8](https://www.python.org/dev/peps/pep-0008)
4041
Contributing a Patch
4142
====================
4243

43-
1. Submit an issue describing your proposed change to the repo in question.
44+
1. Submit an issue describing your proposed change to the repo in question (or work on an existing issue).
4445
1. The repo owner will respond to your issue promptly.
4546
1. Fork the desired repo, develop and test your code changes.
4647
1. Submit a pull request.
@@ -88,15 +89,15 @@ Then you can run the testsuite with::
8889
# Choice of Programming Languages
8990

9091
Are we right to concentrate on Java and Python versions of the code? I think so; both languages are popular; Java is
91-
fast enough for our purposes, and has reasonable type declarations (but can be verbose); Python is popular and has a very direct mapping to the pseudocode in the book (but lacks type declarations and can be slow). The [TIOBE Index](http://www.tiobe.com/tiobe_index) says the top five most popular languages are:
92+
fast enough for our purposes, and has reasonable type declarations (but can be verbose); Python is popular and has a very direct mapping to the pseudocode in the book (but lacks type declarations and can be slow). The [TIOBE Index](http://www.tiobe.com/tiobe_index) says the top seven most popular languages, in order, are:
9293

93-
Java, C, C++, C#, Python
94+
Java, C, C++, C#, Python, PHP, Javascript
9495

95-
So it might be reasonable to also support C++/C# at some point in the future. It might also be reasonable to support a language that combines the terse readability of Python with the type safety and speed of Java; perhaps Go or Julia. And finally, Javascript is the language of the browser; it would be nice to have code that runs in the browser, in Javascript or a variant such as Typescript.
96+
So it might be reasonable to also support C++/C# at some point in the future. It might also be reasonable to support a language that combines the terse readability of Python with the type safety and speed of Java; perhaps Go or Julia. I see no reason to support PHP. Javascript is the language of the browser; it would be nice to have code that runs in the browser without need for any downloads; this would be in Javascript or a variant such as Typescript.
9697

97-
There is also a `aima-lisp` project; in 1995 when we wrote the first edition of the book, Lisp was the right choice, but today it is less popular.
98+
There is also a `aima-lisp` project; in 1995 when we wrote the first edition of the book, Lisp was the right choice, but today it is less popular (currently #31 on the TIOBE index).
9899

99-
What languages are instructors recommending for their AI class? To get an approximate idea, I gave the query <tt>[norvig russell "Modern Approach"](https://www.google.com/webhp#q=russell%20norvig%20%22modern%20approach%22%20java)</tt> along with the names of various languages and looked at the estimated counts of results on
100+
What languages are instructors recommending for their AI class? To get an approximate idea, I gave the query <tt>[\[norvig russell "Modern Approach"\]](https://www.google.com/webhp#q=russell%20norvig%20%22modern%20approach%22%20java)</tt> along with the names of various languages and looked at the estimated counts of results on
100101
various dates. However, I don't have much confidence in these figures...
101102

102103
|Language |2004 |2005 |2007 |2010 |2016 |

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy