Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structure of Prefs, defaults, & setup #38

Closed
sneakers-the-rat opened this issue Oct 30, 2020 · 1 comment
Closed

Structure of Prefs, defaults, & setup #38

sneakers-the-rat opened this issue Oct 30, 2020 · 1 comment

Comments

@sneakers-the-rat
Copy link
Contributor

sneakers-the-rat commented Oct 30, 2020

Better document the parameters in prefs -- finish restructuring of setup routine to further separate prefs, keep a list of default prefs like pvp https://github.com/CohenLabPrinceton/pvp/blob/7d772f093a5706266d372aab2d32535200eeb250/pvp/common/prefs.py#L48 so docs can be generated from docstrings more easily.

Specifically, better document the structure of hardware prefs and how that interacts with the HARDWARE descriptor in a task heading as mentioned here: https://groups.google.com/g/autopilot-users/c/_MqzLDDq3CE/m/AvrIWcwbAAAJ

Currently script, their descriptions, and their names are split across multiple files, these should be unified into a single dict for maintainability/elegance/it just sorta sucks this way.

Prefs should also have a better 'getter' method that returns default values when unset in prefs, or kindly return Nones rather than AttributeErrors

@sneakers-the-rat sneakers-the-rat changed the title Structure of Prefs Structure of Prefs, defaults, & setup Nov 21, 2020
@sneakers-the-rat sneakers-the-rat added this to the v0.4.0 milestone Nov 21, 2020
@sneakers-the-rat
Copy link
Contributor Author

lol what the fuck up its me yer big patchi boi here to close this fuckin issue

  • prefs are now self documenting which also gives them the extra special qualities of being standardized with sensible defaults. we call it NEW PREFS and we LOVE new prefs. note that this is a BREAKING change because prefs now go like prefs.get('KEY') instead of prefs.KEY which was always fragile and implicit anyway. b87a3fc
  • what the fuck we also unified scripts and fixed setup? b87a3fc#diff-247bb8e19fc170654b4b7ca0fb0e490d76c23f42fbc702a5b6923ab7aeebb0ed also related to Programmatic Setup #33
  • better document the parameters in prefs - you better bet we fuckin did it by redesigning the whole dang thing and figuring out an ancient sphinx riddle. ec6d5a7
  • hardware prefs documented here: f3a7609

SO I AM CLOSING THIS ISSUE WITH A VENGEANCE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant