Feat/project structure #8
Conversation
DavidSouther
force-pushed
the
feat/project_structure
branch
from
1c721a4
to
4c00710
Compare
There was a problem hiding this comment.
In general I think the organization is good, clean, and easy to read and understand. Lots of good separation of concerns, etc. I understand that there's currently some redundancy because of the yamale validator overlapping with DocGen, and that's fine until we can bring everything together.
- I put a comment somewhere but I'll just call this out here, too--I think the biggest issue is that
examplesis a list and not a dict (with ID for key) and that new examples are not merged, just appended to the list. The zexi design is to merge examples with the same ID, but only to take new language sections from secondary sources (all other fields are not merged, and language sections that already exist are not overridden). - I saw a few fields in the dataclasses (like more_info) that aren't yet used in the metadata anywhere (nor are they included in any spec yet). I generally think it's not a good idea to include speculative code because it either never gets used or never gets tested until you need it (and find it doesn't work).
- I'm also not too fond of TODOs left in code. I'd raise exceptions, perhaps? Or implement the TODOs. Or take them out and track them elsewhere.
DavidSouther
force-pushed
the
feat/project_structure
branch
from
19fe695
to
4ca27de
Compare
|
|
| from aws_doc_sdk_examples_tools.metadata_errors import MetadataErrors | ||
| from aws_doc_sdk_examples_tools.metadata_validator import validate_metadata | ||
| from aws_doc_sdk_examples_tools.project_validator import ( | ||
| from .metadata import Example, parse as parse_examples |
There was a problem hiding this comment.
Whoa, you can do this .metadata syntax? Docs?
There was a problem hiding this comment.
DavidSouther
added
Enhancement
Updates to project structure that better support internal use cases.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.