From: Ian Kelling Date: Wed, 2 Jul 2014 03:38:28 +0000 (-0700) Subject: minor doc update X-Git-Url: https://iankelling.org/git/?p=spray;a=commitdiff_plain;h=a07d2e2ea239d6d1c7f44a221972a07ef4e14a6d minor doc update --- diff --git a/Readme.org b/Readme.org index 334b33a..dcdf47e 100644 --- a/Readme.org +++ b/Readme.org @@ -98,11 +98,6 @@ You may customize spray by modifying following items: ** Algorithm details -*** Why? -Based on a quick count, similar programs are implemented in 6 languages, 9 platforms and 11+ projects. The core algorithm is choosing a word, an accent character and an interval to display it, and how to do that best is quite important. However, how exactly each project implements that algorithm is generally buried in unrelated code, and mostly undocumented. It is extremely difficult and time consuming to figure out the exact algorithm and differences between them for each project, and I don't think it's hardly ever been done. This sucks. Users would like to know so they can pick one. Developers would like to know so that they can improve their implementation of the algorithm. - -So, I am opening a bug on every project I find, asking them to document what file and function(s) their algorithm is implemented in, and preferably to document it in english as well. The following is an example. - *** Algorithm code location This project's implementation is located in ./spray.el The functions =spray--word-at-point=, =spray--update= and =spray-start= contain the main of the algorithm. Word splitting is also duplicated the same way as in those functions throughout ./spray.el. @@ -120,7 +115,12 @@ The accent location is chosen as the nth character in a word, depending on its l | 6-9 | 3 | | 10-13 | 4 | | 14+ | 5 | - + +*** Why? +Based on a quick count, similar programs are implemented in 6 languages, 9 platforms and 11+ projects. Every one has a similar algorithm to choose a word, an accent character and an interval to display it. How to do that best is quite important. However, how each project does it is generally buried in unrelated code, and mostly undocumented. It is prohibitively time consuming to figure out the algorithm and differences between them for each project. This sucks. Users would like to know so they can pick one. Developers would like to know so they can get ideas and spread improvements among different projects. + +So, I am opening a bug on every project I find, asking them to document what file and function(s) their algorithm is implemented in, and preferably to document it in english as well. The following is an example. + ** Contributions are welcome!