Skip to content

Review placeholders in docstrings. #36

@Poikilos

Description

@Poikilos

PR #32 fills in some of the docstring placeholders, but beyond that, I'd need help filling in the following placeholders in pregenerated docstrings potentially in a few different files:

  • _type_

  • _description_

  • I made this change to spaceDecode in memoryservice.py but I'm not sure what the number actually is:

-            tuple(bool, byte): (False, 1-3 for in command byte) :
+            tuple(bool, byte): (False, 1-3 representing low 2 bits in command byte):
  • What does that number actually mean? A command or address, and referring to what?
  • I added this to the same file:
            space (int): Encoded memory space identifier, where values:
            - 0xFF to 0xFD are special spaces, and only the least significant
              2 bits are relevant.
            - 0x00 to 0xFC represent standard memory spaces directly.
  • This says how the numbers are used, but I'd like to replace that with comments that answer "why" and "how" rather than what bits are used (my preliminary comment pretty much translates code to English, which doesn't actually explain why it is coded that way or how the data is used)
  • I had added space(_type_): _description_ a few times in the code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions