search

bbcmicrobit / micropython

Port of MicroPython for the BBC micro:bit
https://microbit-micropython.readthedocs.io
Other
603 stars 284 forks source link

docs : Improved REPL information regarding serial terminals screen and picocom #621

Closed rhubarbdog closed 5 years ago

rhubarbdog commented 5 years ago

The documentation to terminate serial terminal screen were incorrect the documentation to terminate picocom didn't exist

microbit-carlos commented 5 years ago

Thank you so much @rhubarbdog! I've added a few comments, mostly to simplify a bit the content. If you haven't used GH "suggested changes" feature before, there is some info here: https://help.github.com/articles/incorporating-feedback-in-your-pull-request/#applying-a-suggested-change

Could you also check that lines are only 79 characters long or fewer? There is a few trailing whitespaces as well (a left over whitespace at the end of the line), it be great if you could remove those too.

Thank you again for the submission, is certainly appreciated!

rhubarbdog commented 5 years ago

Hi @microbit-carlos , you probably need to check this, i kinda screwed up accepting your suggestions. I accepted one of them which updated the mac section but had no equal suggestion for the linux section. i edited repl.rst by hand, this outdated some diffs and i've been freestyling since then. GitHub updated a diff but when i applied it things no longer made sence in the document.

rhubarbdog commented 5 years ago

The above 3 commits are on README.md i didn't intend them to be included in this pull request. They are totally independent topics

microbit-carlos commented 5 years ago

Thanks for the update @rhubarbdog. Yes, if you add more commits to the branch they will end up in the PR. You can revert the commit and submit in a new branch/PR for the REAME changes.

rhubarbdog commented 5 years ago

@microbit-carlos the instructions to revert a pull request https://help.github.com/articles/reverting-a-pull-request/ seem to be out of date. I can't find any screen with a revert button. can you refuse those commits? I can type them back in at a later date.

microbit-carlos commented 5 years ago

Hi @rhubarbdog ,

Right, I think those instructions are for reverting an already merged PR using the GH web interface. I was referring to do a 'git revert', this looks like a good article about this type of operation: https://www.atlassian.com/git/tutorials/undoing-changes/git-revert

rhubarbdog commented 5 years ago

hi @microbit-carlos , That was a bit of a learning curve. I have never used the command git. I've accepted / performed your suggested edits and have reverted those edits to README.md

microbit-carlos commented 5 years ago

Thank you for your perseverance, it's really appreciated! PR is ready, I'll merge it now :)