Attention is currently required from: fixeria.
dexter has posted comments on this change by fixeria. ( https://gerrit.osmocom.org/c/pysim/+/42551?usp=email )
Change subject: docs: auto-generate Card Filesystem Reference ......................................................................
Patch Set 4: Code-Review+1 Verified+1
(3 comments)
Patchset:
PS4: I have now looked through this and also tried it out. As it seems everything works as expected. Please have a quick look at the two comments I put.
As it seems now we now need more unit-tests so that the manual gets more examples...
File docs/pysim_fs_sphinx.py:
https://gerrit.osmocom.org/c/pysim/+/42551/comment/604ce236_f5d59c70?usp=ema... : PS4, Line 121: for attr in ('_test_de_encode', '_test_decode'): we do not use _test_encode here? I know we rarely have it. I think EF_MSISDN is the only file that uses it.
https://gerrit.osmocom.org/c/pysim/+/42551/comment/5453a005_c6267dd2?usp=ema... : PS4, Line 144: lines.append(f' // {comment}\n') This appears in the JSON examples in the manual. For me it is obvious what this means, but maybe users will copy+paste those examples. Then the comment causes an error. Maybe we should add functionality to pySim-shell to strip any comments from the JSON? I also think that we had this discussion before. If you say a good way how to format this differently in the manual text, I would recommend to change this. If it is difficult or messes up the formatting I would keep it like it is.