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

Add documentation for updated survey system #294

Merged
merged 5 commits into from
Apr 22, 2022

Conversation

thuiop
Copy link
Collaborator

@thuiop thuiop commented Apr 16, 2022

No description provided.

@thuiop thuiop added docs documentation WiP Work in Progress labels Apr 16, 2022
@thuiop thuiop added this to the v0.9.9 milestone Apr 16, 2022
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov
Copy link

codecov bot commented Apr 16, 2022

Codecov Report

Merging #294 (81ad74d) into develop (7fa57fb) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop     #294   +/-   ##
========================================
  Coverage    89.03%   89.03%           
========================================
  Files           13       13           
  Lines         1560     1560           
========================================
  Hits          1389     1389           
  Misses         171      171           
Flag Coverage Δ
unittests 89.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7fa57fb...81ad74d. Read the comment docs.

@thuiop
Copy link
Collaborator Author

thuiop commented Apr 18, 2022

I am currently rewriting the “custom_tutorial” notebook ; it used to explain how to create a new survey. Should I remove that and restrict to modifying existing surveys, as it is now more complex to create new ones from scratch ? @ismael-mendoza

@ismael-mendoza
Copy link
Collaborator

ismael-mendoza commented Apr 18, 2022

Hi @thuiop I think what you ask is exactly what we were thinking in #291 - we can do this later and for now you can remove this from the notebook and just explain how to modify existing ones. Thanks!

@ismael-mendoza ismael-mendoza linked an issue Apr 20, 2022 that may be closed by this pull request
@thuiop thuiop force-pushed the galcheat-documentation branch from aaa0648 to 56b6a00 Compare April 20, 2022 17:17
@thuiop thuiop changed the title WIP: Add documentation for updated survey system Add documentation for updated survey system Apr 20, 2022
@thuiop thuiop added Ready for review For PR which should be reviewed and removed WiP Work in Progress labels Apr 20, 2022
@thuiop
Copy link
Collaborator Author

thuiop commented Apr 20, 2022

I believe it should be ready for review @ismael-mendoza

@ismael-mendoza ismael-mendoza self-requested a review April 20, 2022 17:47
@ismael-mendoza
Copy link
Collaborator

will take a look later today, thanks @thuiop !

@review-notebook-app
Copy link

review-notebook-app bot commented Apr 22, 2022

View / edit / reply to this conversation on ReviewNB

ismael-mendoza commented on 2022-04-22T00:54:08Z
----------------------------------------------------------------

Why did you change the meas_band_name to meas_band_num ?


ismael-mendoza commented on 2022-04-22T00:55:03Z
----------------------------------------------------------------

(same below, I think there is another cell where you do this)

thuiop commented on 2022-04-22T12:50:27Z
----------------------------------------------------------------

Hmmm that's weird, I am pretty sure I actually did the reverse change somewhere. There may have been a rebase problem at some point.

ismael-mendoza commented on 2022-04-22T13:13:22Z
----------------------------------------------------------------

thanks!

Copy link
Collaborator

(same below, I think there is another cell where you do this)


View entire conversation on ReviewNB

@ismael-mendoza
Copy link
Collaborator

ismael-mendoza commented Apr 22, 2022

Thanks @thuiop this is looking good- I just had a small comment in one of the notebooks (see above)

Copy link
Collaborator Author

thuiop commented Apr 22, 2022

Hmmm that's weird, I am pretty sure I actually did the reverse change somewhere. There may have been a rebase problem at some point.


View entire conversation on ReviewNB

Copy link
Collaborator

thanks!


View entire conversation on ReviewNB

@ismael-mendoza
Copy link
Collaborator

looks great, merging now

@ismael-mendoza ismael-mendoza merged commit 9d19924 into develop Apr 22, 2022
@ismael-mendoza ismael-mendoza deleted the galcheat-documentation branch April 22, 2022 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation Ready for review For PR which should be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add documentation from change to galcheat
2 participants