Doc pull request failed

[hlovatt]

Hi,

Tried to update the documentation for the `pyb.SPI` class, but it failed: https://github.com/micropython/micropyt ... /154777451.

I edited the file in Github and issued the request from Github.

[pythoncoder]

I'm not sure what your query is. The quick way to do minor doc changes is as you found, to edit the file on GitHub and issue a PR.

For more complex changes, or code changes that you need to test locally, ensure you have a fork of the source tree. Clone your fork to your PC. Create a branch and check it out. Do your changes and push the branch to GitHub. On GitHub go to your fork, change to the branch, and issue the PR.

[jimmo]

Tried to update the documentation for the `pyb.SPI` class, but it failed: https://github.com/micropython/micropyt ... /154777451.

The github actions UI is kind of confusing. If you click on the "x build" subheading on the left hand side, then expand the "build docs" heading, it shows the full log of generating the documentation.

In this case the error is:

Code: Select all

/home/runner/work/micropython/micropython/docs/library/pyb.SPI.rst:67: WARNING: Inline literal start-string without end-string.

This is because ``ti` should be ``ti``

[hlovatt]

Thanks will do the pull request again.