Closed GFMoraga closed 11 months ago
@bourque I copied your comment from the PR as a starter. I will go back and edit/update.
Thanks @GFMoraga. I am also happy to help out with some of this!
@maxinelasp can you suggest names for classes? Or do you think these are fine? I am working on this comment:
"It is best practice to have the main function be really small and call out to other methods (IMO). Ideally, this would look something like:"
df = parse_excel_file(filename) header = generate_header() integer_parameter_types = generate_integer_parameter_types() codice_parameters = generate_codice_parameters() tree = generate_xml_tree(df, header, integer_parameter_types, codice_parameters) tree.write(...)
@tech3371 how do I do this? "We need to add pandas, openpyxl to poetry dependency list" in poety.toml?
Make sure your names are clear, with spelled out names (per the style guide). Ideally, it should be clear what the class is without other developers needing to read any documentation or comments. If you're having trouble describing a class in 2-3 words, that is a sign the class is too complicated and may need to be split down further.
Here's an interesting discussion that might help. Naming things is difficult and annoying 😆
You can also look at space_packet_parser
for examples of class names/structure.
Also, per your poetry question, I will write up a document about using poetry which we can use as a start.
Sounds good! I will take a look, and yes, naming things, I am learning is harder than I thought!
@GFMoraga I found this book very helpful. I read first few chapters. Chapter 2 talks about how to name functions well. I hope it helps. https://github.com/jnguyen095/clean-code/blob/master/Clean.Code.A.Handbook.of.Agile.Software.Craftsmanship.pdf
Summary
This is a way to track the progress of updating the xtce files and parsing tools
Completed
Requirements
The more specific the better.
Related tickets
72