Browse Source

Python: rm minor version from embedding docs link

D. Bohdan 2 years ago
parent
commit
a7288d935a
3 changed files with 20 additions and 4 deletions
  1. 18 2
      CONTRIBUTING.md
  2. 1 1
      README.md
  3. 1 1
      data/projects.toml

+ 18 - 2
CONTRIBUTING.md

@@ -2,8 +2,24 @@
 
 ## What and how to contribute
 
-Please submit a pull request or create an issue to add a new language to the list. We are looking for language implementations that are either actively maintained or largely "done". The VM, bytecode compiler, and standard library (if any) must have a free (*libre*) license. They may have optional add-ons with any license. A Datalog implementation must be able to parse Datalog source code; it must not be just an [EDSL](https://en.wikipedia.org/wiki/Domain-specific_language#External_and_Embedded_Domain_Specific_Languages).
+Please submit a pull request or create an issue to add a new language to the list.
+We are looking for language implementations that are either actively maintained or largely "done".
+The VM, bytecode compiler, and standard library (if any) must have a free (*libre*) license.
+They may have optional add-ons with any license.
+A Datalog implementation must be able to parse Datalog source code;
+it must not be just an [EDSL](https://en.wikipedia.org/wiki/Domain-specific_language#External_and_Embedded_Domain_Specific_Languages).
 
 ## Do not edit `README.md` directly
 
-`README.md` is automatically generated from `README.md.jinja2` and the data in [`data/projects.toml`](data/projects.toml). Do not edit `README.md` directly. To add a project or update a project's information, edit `data/projects.toml`. Edit `README.md.njk` to change information not derived from `data/projects.toml`.
+`README.md` is automatically generated from `README.md.jinja2` and the data in [`data/projects.toml`](data/projects.toml).
+Do not edit `README.md` directly.
+To add a project or update a project's information, edit `data/projects.toml`.
+Edit `README.md.njk` to change information not derived from `data/projects.toml`.
+
+## Descriptions
+
+Avoid marketing language in descriptions.
+You are encouraged to list a few of the project's cool standout features in the description,
+but don't call the project itself "fast" (relative to what?) or "revolutionary" (a matter of opinion).
+Write without adjectives when possible.
+If the project is faster than most implementations of the same language, say that.

+ 1 - 1
README.md

@@ -99,7 +99,7 @@ To sort and filter the list interactively, visit the [webpage](https://dbohdan.g
 | Python | [Jython](http://www.jython.org/) | Java | JVM's GC | PSFL (BSD-like) | An implementation of Python 2 for the JVM. |
 | Python | [MicroPython](https://github.com/micropython/micropython) | C | Tracing | MIT | Implements the Python 3.4 syntax and some of the core datatypes. |
 | Python | [pocketpy](https://github.com/blueloveTH/pocketpy) | C++ | Tracing | MIT | Implements a subset of Python 3 (with [some differences](https://pocketpy.dev/features/differences/#different-behaviors)) in a single C++17 header file. |
-| Python | [Python](https://www.python.org/) | C | Ref. counting + cycle-detecting tracing GC | PSFL (BSD-like) | [Embedding Python in Another Application](https://docs.python.org/3.5/extending/embedding.html). |
+| Python | [Python](https://www.python.org/) | C | Ref. counting + cycle-detecting tracing GC | PSFL (BSD-like) | ["Embedding Python in Another Application"](https://docs.python.org/3/extending/embedding.html). |
 | QuakeC | [gmqcc/qcvm](https://github.com/graphitemaster/gmqcc) | C++ | None (no dynamic memory allocation) | MIT | A QuakeC compiler and VM. |
 | Quirrel | [Quirrel](https://github.com/GaijinEntertainment/quirrel) | C++ | Ref. counting | MIT | A fork of Squirrel with [new features](https://quirrel.io/doc/reference/diff_from_original.html). |
 | Rebol | [Rebol](https://github.com/Oldes/Rebol3) | C | Tracing | Apache License 2.0 | Relative Expression Based Object Language |

+ 1 - 1
data/projects.toml

@@ -742,7 +742,7 @@ lang = "Python"
 impl_in = "C"
 gc = "Ref. counting + cycle-detecting tracing GC"
 license = "PSFL (BSD-like)"
-notes = "[Embedding Python in Another Application](https://docs.python.org/3.5/extending/embedding.html)."
+notes = "[\"Embedding Python in Another Application\"](https://docs.python.org/3/extending/embedding.html)."
 
 ["gmqcc/qcvm"]
 url = "https://github.com/graphitemaster/gmqcc"