search

olofk / ipyxact

Python-based IP-XACT parser
MIT License
124 stars 48 forks source link

gen_markdown.py: print names and descriptions #36

Closed amirgon closed 2 years ago

amirgon commented 2 years ago

Memory maps and address blocks can specify name and description. Print them out in the Markdown file, when they are specified.

amirgon commented 2 years ago

Also added bugfix for enumeratedValues printing.

olofk commented 2 years ago

Many thanks. This looks fine to me. Please note though that there is a new API coming up that will eventually replace the old one

amirgon commented 2 years ago

Please note though that there is a new API coming up that will eventually replace the old one

@olofk - Could you elaborate on this?
Why is the API changing? What is wrong with the existing API? Where is the new API defined?

Please take into account that many people are already using your library. It's very useful and easy to use in its current state. I doubt many would take the trouble to refactor their code to use the new API on existing code. So once you remove the current API, many would remain locked to an older version of ipyxact that supports the old API.
Did you consider this?

olofk commented 10 months ago

Missed replying to this @amirgon . The biggest issue is that current API only covers a small subset of IP-XACT and it would require a ton of work to do it all. With the new API I can automatically generate the Python classses directly from the official xsd files. It does need some fixups, but that's nothing compared to what would be needed to do a manual implementation. The API is also surprisingly similar, so hopefully it won't be too much work to port over existing code.