-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Fix constant names and typos in aioble examples and deepcopy function #1058
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
c257617
6b7bc90
9788109
66a6b11
e8c0a9c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # DS18x20 temperature sensor driver for MicroPython. | ||
| """DS18x20 temperature sensor driver for MicroPython.""" | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why this change? If it should be a docstring, then why not also include the below license/copyright line as well? |
||
|
|
||
| # MIT license; Copyright (c) 2016 Damien P. George | ||
|
|
||
| from micropython import const | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,18 +3,18 @@ | |
| Interpreters constructed with this class obey the following conventions: | ||
| 1. End of file on input is processed as the command 'EOF'. | ||
| 2. A command is parsed out of each line by collecting the prefix composed | ||
| 2. A command is parsed out of each line by collecting the prefix composed | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think it should add a space at the end of the line. |
||
| of characters in the identchars member. | ||
| 3. A command `foo' is dispatched to a method 'do_foo()'; the do_ method | ||
| 3. A command 'foo' is dispatched to a method 'do_foo()'; the do_ method | ||
| is passed a single argument consisting of the remainder of the line. | ||
| 4. Typing an empty line repeats the last command. (Actually, it calls the | ||
| method `emptyline', which may be overridden in a subclass.) | ||
| 5. There is a predefined `help' method. Given an argument `topic', it | ||
| calls the command `help_topic'. With no arguments, it lists all topics | ||
| method ``emptyline``, which may be overridden in a subclass.) | ||
| 5. There is a predefined ``help`` method. Given an argument 'topic', it | ||
| calls the command 'help_topic'. With no arguments, it lists all topics | ||
| with defined help_ functions, broken into up to three topics; documented | ||
| commands, miscellaneous help topics, and undocumented commands. | ||
| 6. The command '?' is a synonym for `help'. The command '!' is a synonym | ||
| for `shell', if a do_shell method exists. | ||
| 6. The command '?' is a synonym for 'help'. The command '!' is a synonym | ||
| for 'shell', if a do_shell method exists. | ||
| 7. If completion is enabled, completing commands will be done automatically, | ||
| and completing of commands args is done by calling complete_foo() with | ||
| arguments text, line, begidx, endidx. text is string we are matching | ||
|
|
@@ -23,32 +23,33 @@ | |
| indexes of the text being matched, which could be used to provide | ||
| different completion depending upon which position the argument is in. | ||
| The `default' method may be overridden to intercept commands for which there | ||
| The 'default' method may be overridden to intercept commands for which there | ||
| is no do_ method. | ||
| The `completedefault' method may be overridden to intercept completions for | ||
| The ``completedefault`` method may be overridden to intercept completions for | ||
| commands that have no complete_ method. | ||
| The data member `self.ruler' sets the character used to draw separator lines | ||
| The data member ``self.ruler`` sets the character used to draw separator lines | ||
| in the help messages. If empty, no ruler line is drawn. It defaults to "=". | ||
| If the value of `self.intro' is nonempty when the cmdloop method is called, | ||
| If the value of ``self.intro`` is nonempty when the cmdloop method is called, | ||
| it is printed out on interpreter startup. This value may be overridden | ||
| via an optional argument to the cmdloop() method. | ||
| The data members `self.doc_header', `self.misc_header', and | ||
| `self.undoc_header' set the headers used for the help function's | ||
| The data members ``self.doc_header``, ``self.misc_header``, and | ||
| ``self.undoc_header`` set the headers used for the help function's | ||
| listings of documented functions, miscellaneous topics, and undocumented | ||
| functions respectively. | ||
| ---------------------------------------------------------------------------- | ||
| This is a copy of python's Cmd, but leaves out features that aren't relevant | ||
| or can't currently be implemented for MicroPython. | ||
| .. caution:: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I really don't think we should be using RST formatting here. |
||
| This is a copy of python's Cmd, but leaves out features that aren't relevant | ||
| or can't currently be implemented for MicroPython. | ||
| One of the notable deviations is that since MicroPython strips doc strings, | ||
| this means that that help by doc string feature doesn't work. | ||
| One of the notable deviations is that since MicroPython strips doc strings, | ||
| this means that that help by doc string feature doesn't work. | ||
| completions have also been stripped out. | ||
| completions have also been stripped out. | ||
| """ | ||
|
|
||
| import sys | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not against this indenting change, but doe we need to make it RST compatible with the double colon?
I'm curious why you made the change / how you found these problems? It's not really supposed to be RST format.