A clean codebase - Githubissues

OCESS / orbitx

Rewrite of OrbitV, maintained by Patrick, Gavin, and contributors

MIT License

10 stars 18 forks source link

A clean codebase #27

Closed pmelanson closed 5 years ago

pmelanson commented 5 years ago

An ongoing issue. When developing, we should make sure our code adheres to PEP8 style guide, Has public APIs and any important internal helpers well-documented, and our code is generally readable.

pmelanson commented 5 years ago

Hey @goodday0404 per the meeting can you help with docstrings in flight_gui i know its a bad file (also type annotations)

we should clean it up sometime

pmelanson commented 5 years ago

Some other thoughts on how to improve graphics code:

make Displayable more generic, just an __init__ and an update
put module comments?
factor out HRT again maybe