litebird / litebird_sim

Simulation tools for LiteBIRD
GNU General Public License v3.0
19 stars 13 forks source link

Reorganize the User’s manual #342

Closed ziotom78 closed 6 days ago

ziotom78 commented 1 week ago

This PR addresses issue #341.

ziotom78 commented 1 week ago

I have completed fixing the grammar. Could somebody please have a look at the way the documentation looks now? Here is a screenshot with the new style:

image

paganol commented 1 week ago

Hi @ziotom78, I like it, thanks!! I just added an example for the high level interface in the noise section.

I also took the opportunity for changing the default behavior of Simulation.add_noise, before we had to pass explicitly the random number generator, now, if random is empty, self.random is used. This change doesn't really belong to this PR, so if you think that it should be in a separate PR I can do that, let me know.

https://github.com/litebird/litebird_sim/blob/bcf9cc07ef8977cea3069dc3903967a8ea7ff5f6/litebird_sim/simulations.py#L1549-L1574

ziotom78 commented 1 week ago

I also took the opportunity for changing the default behavior of Simulation.add_noise, before we had to pass explicitly the random number generator, now, if random is empty, self.random is used. This change doesn't really belong to this PR, so if you think that it should be in a separate PR I can do that, let me know.

I know it’s boring, but having a separate PR for it would be clearer to users. This would let us properly advertise this change in the CHANGELOG by referencing the right PR.

paganol commented 1 week ago

For me we can merge