Minor correction to the Read The Docs

[Timeline8]

Under the I2C class for EEPROM parameters currently reads as "max_int – (Optional) " should be "max_size (int) - (Optional)"

Also I didn't know how to do it, but in the read the docs page the " Default is _MAX_SIZE_I2C " part reads out at literally "_MAX_SIZE_I2C" instead of like it does above in the class

class adafruit_24lc32.EEPROM_I2C(i2c_bus: busio.I2C, address: int = 80, write_protect: bool = False, wp_pin: DigitalInOut | None = None, max_size: int = 4096)¶

[tannewt]

Thanks! I'm not sure what you are asking about.

[FoamyGuy]

I think maybe @Timeline8 was referring to the way the docs render the max_size argument default:

In the function signature it seems to be able to figure out the value of _MAX_SIZE_I2C is 4096 and show that. Whereas below in the vertical list of arguments it shows the variables name "_MAX_SIZE_I2C" instead of it's value.

I don't know why RTD / sphinx is able to fill in the variable value for one and not the other. We could hardcode 4096 in the docstring if we wanted then the docs would show it the same in both places, but if the value of the variable were ever changed in this library or one copied from it that value could get stale. Maybe that is not that big of a risk though.

[Timeline8]

Looks like the main point I posted got fixed (was it my edit?). where it now correctly shows in the Read the docs that it should be max_size (int) ...

it was saying "max_int – (Optional)" which was nonsense.

[Timeline8]

Here was my edit...

[Timeline8]

And my secondary comment was how these two didn't seem to mesh correctly (as @FoamyGuy correctly pointed out)...

Where in the "class" line at the top is properly shows the default as 4096 but in the text below it gives the vague "_MAX_SIZE_I2C" rather than an integer number.

[tannewt]

Ah! Ya, signature information is determined by actually loading the code. The doc string isn't evaluated at all. That's also why address is 80 in the signature but 0x50 in the docs. You could remove the mention of the default in the doc string completely because that info is in the signature already.