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

Check why it works for maths lines we can do without #84

Closed
seabbs opened this issue Sep 18, 2024 · 9 comments · Fixed by #116
Closed

Check why it works for maths lines we can do without #84

seabbs opened this issue Sep 18, 2024 · 9 comments · Fixed by #116
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@seabbs
Copy link
Contributor

seabbs commented Sep 18, 2024

I.e in the analytical solutions there are a few substitutions where we first write out the full equation vs just subbing in our already solved component chunks. The fear is this might be confusing to readers and might not really add much. Based on #68

@seabbs seabbs added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 18, 2024
@seabbs
Copy link
Contributor Author

seabbs commented Sep 18, 2024

Refers to this: #68 (comment)

and similar.

Potentially this can be reviewed along side #72

@seabbs
Copy link
Contributor Author

seabbs commented Sep 19, 2024

@SamuelBrand1 did you catch this in your PR? I think no?

@SamuelBrand1
Copy link
Collaborator

No.

Maybe @parksw3 could give a bit of feedback? I'm possible a bit too close to decide what reads well/ is useful vs not!

@parksw3
Copy link

parksw3 commented Sep 19, 2024

Sorry for the confusion, but should I read the math or code? If you could point me to where to look, that would be helpful... the title sounds like simplifying math but the comments sound like simplifying the code...

@seabbs
Copy link
Contributor Author

seabbs commented Sep 19, 2024

The maths. The link is to the Rmd doc so we can get the line number 2017

@seabbs
Copy link
Contributor Author

seabbs commented Sep 19, 2024

Essentially it boils down to should we get rid of the first term in 3.9 because we actually arrive at the second line by subbing the components we have just derived into the last line of 3.5

and the same point for the lognormal

@seabbs
Copy link
Contributor Author

seabbs commented Sep 30, 2024

Lack of traction here. As this is relatively easy to close shall we either PR a quick change or close this as won't do

@SamuelBrand1
Copy link
Collaborator

Hey @seabbs . I think there is a tension here because we also want to be clear... replication not necessarily bad in the maths.

@seabbs
Copy link
Contributor Author

seabbs commented Sep 30, 2024

My point is that I think in these instances it is unclear as it adds additional lines of maths for readers to take in that don't actually advance the argument and aren't clearly signposted. So from my view solutions would be either to more clearly signpost the steps/links or to remove.

@seabbs seabbs self-assigned this Oct 4, 2024
seabbs added a commit that referenced this issue Oct 4, 2024
* remove spare lines of code

* update news
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants