<feed xmlns='http://www.w3.org/2005/Atom'>
<title>suspect-devices/circuitpython/tools/gen-cpydiff.py, branch main</title>
<subtitle>CircuitPython - a Python implementation for teaching coding with microcontrollers</subtitle>
<id>https://git.suspectdevices.com/suspect-devices/circuitpython/atom?h=main</id>
<link rel='self' href='https://git.suspectdevices.com/suspect-devices/circuitpython/atom?h=main'/>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/'/>
<updated>2018-05-14T18:02:25+00:00</updated>
<entry>
<title>Cleaning up and fixing the docs generation Makefile and README instructions</title>
<updated>2018-05-14T18:02:25+00:00</updated>
<author>
<name>Karin Hawley</name>
<email>karin@joinhonor.com</email>
</author>
<published>2018-05-14T17:32:01+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=f9ae1ee1729b16a2459a93f1c777f851e0418a6b'/>
<id>urn:sha1:f9ae1ee1729b16a2459a93f1c777f851e0418a6b</id>
<content type='text'>
- moving Makefile to parent folder.  This resolves some of the weird path/build issues
- remove trace references to cpydiff and original file (no longer used anywhere)
- converting SOURCEDIR to a changeable variable, passed through all sphinx-build calls
- adding path to conf.py, in case it moves again
- making `-v` default with VERBOSE
- making `-E` default with FORCE
- creating BASEOPTS to store all the dirs, paths, and settings, passing them to sphinx-build in one long chain, instead of individually
- updating README to use the make command as default.  Also added text explaining some of the customization you can add into a make command
</content>
</entry>
<entry>
<title>all: Use the name MicroPython consistently in comments</title>
<updated>2017-07-31T08:35:40+00:00</updated>
<author>
<name>Alexander Steffen</name>
<email>devel.20.webmeister@spamgourmet.com</email>
</author>
<published>2017-06-30T07:22:17+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=55f33240f3d7051d4213629e92437a36f1fac50e'/>
<id>urn:sha1:55f33240f3d7051d4213629e92437a36f1fac50e</id>
<content type='text'>
There were several different spellings of MicroPython present in comments,
when there should be only one.
</content>
</entry>
<entry>
<title>tools/gen-cpydiff: Use case description as 3rd-level heading.</title>
<updated>2017-07-09T10:51:40+00:00</updated>
<author>
<name>Paul Sokolovsky</name>
<email>pfalcon@users.sourceforge.net</email>
</author>
<published>2017-07-09T10:51:40+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=ad5e7a0e6f991e923fe94cce444289252304f589'/>
<id>urn:sha1:ad5e7a0e6f991e923fe94cce444289252304f589</id>
<content type='text'>
This is required to easily giving links to a particular difference case.
Also, add RST anchors to allow cases to cross-reference each other.
</content>
</entry>
<entry>
<title>tools/gen-cpydiff.py: configurable CPython and micropython executables</title>
<updated>2017-02-27T04:39:55+00:00</updated>
<author>
<name>Krzysztof Blazewicz</name>
<email>blazewicz.krzysztof@gmail.com</email>
</author>
<published>2017-02-25T12:53:56+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=23ccb3e12e3b7fe6b56785d1e17e9d990d1da86c'/>
<id>urn:sha1:23ccb3e12e3b7fe6b56785d1e17e9d990d1da86c</id>
<content type='text'>
</content>
</entry>
<entry>
<title>tools/gen-cpydiff.py: Set the Python import path to find test modules.</title>
<updated>2017-02-22T04:50:58+00:00</updated>
<author>
<name>Damien George</name>
<email>damien.p.george@gmail.com</email>
</author>
<published>2017-02-22T04:50:58+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=1034d9acc84317b21b953d3e9fd6ad5519d1c570'/>
<id>urn:sha1:1034d9acc84317b21b953d3e9fd6ad5519d1c570</id>
<content type='text'>
</content>
</entry>
<entry>
<title>tools: Add gen-cpydiff.py to generate docs differences.</title>
<updated>2017-02-20T06:14:34+00:00</updated>
<author>
<name>Rami Ali</name>
<email>flowergrass@users.noreply.github.com</email>
</author>
<published>2017-02-07T05:43:41+00:00</published>
<link rel='alternate' type='text/html' href='https://git.suspectdevices.com/suspect-devices/circuitpython/commit/?id=b7fa63c7ced460fd2d3aceb35257a62ff08831c1'/>
<id>urn:sha1:b7fa63c7ced460fd2d3aceb35257a62ff08831c1</id>
<content type='text'>
This patch introduces the a small framework to track differences between
uPy and CPython.  The framework consists of:

- A set of "tests" which test for an individual feature that differs between
  uPy and CPy.  Each test is like a normal uPy test in the test suite, but
  has a special comment at the start with some meta-data: a category (eg
  syntax, core language), a human-readable description of the difference, a
  cause, and a workaround.  Following the meta-data there is a short code
  snippet which demonstrates the difference.  See tests/cpydiff directory
  for the initial set of tests.

- A program (this patch) which runs all the tests (on uPy and CPy) and
  generates nicely-formated .rst documenting the differences.

- Integration into the docs build so that everything is automatic, and the
  differences appear in a way that is easy for users to read/reference (see
  latter commits).

The idea with using this new framework is:

- When a new difference is found it's easy to write a short test for it,
  along with a description, and add it to the existing ones.  It's also easy
  for contributors to submit tests for differences they find.

- When something is no longer different the tool will give an error and
  difference can be removed (or promoted to a proper feature test).
</content>
</entry>
</feed>
