search

wbalmer / backtracks

Python package to fit relative astrometry with background star motion tracks.
https://backtracks.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
6 stars 2 forks source link

Actually document in the docstrings #41

Closed wbalmer closed 8 months ago

wbalmer commented 8 months ago

lol

gotten commented 8 months ago

If we have a working example for one function we can split the work and chip away at the rest.

species might be a good example

wbalmer commented 8 months ago

Sounds like a plan! I'll start on this next week.

gotten commented 8 months ago

OK, i'm working on the description of the utils.py functions. docs seem to compile on my machine. See https://github.com/gotten/backtracks/tree/docs for progress.

It might not be perfect/complete in the first try but we can improve it bit by bit. I will make a PR when I'm reasonably happy with utils.py.

gotten commented 8 months ago

There might have been an error in pol2car until I noticed it while writing docstrings: https://github.com/gotten/backtracks/commit/80cd611745f2c26487582395fb5d82c87854a3cf

Can you comment on this @wbalmer? Probably had the biggest impact for GRAVITY errors that can have a big ratio between axes.

wbalmer commented 8 months ago

Ah, looks like that is an error, yes, the order should be x1, x2, x1_err, x2_err. could have affected some of our gravity runs slightly. we can merge that asap and push that and our recent changes to pypi early next week.

wbalmer commented 8 months ago

I'll close this for now since each function has a docstring! We will continue to revise and improve them for clarity as we update the package.