-
Notifications
You must be signed in to change notification settings - Fork 434
Fixes minor typos in referencing equations. #7415
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
Conversation
|
e7a6323
to
c2943ca
Compare
c2943ca
to
8537409
Compare
@peterdschwartz please approve and merge this. |
@bishtgautam I'm seeing a few error messages like: "Label 'eqn_xxx' multiply defined" |
@peterdschwartz Where are you seeing those errors? I looked at following locations, but could not find the error: |
Oh, I found those errors. They are showing up on the rendered page https://docs.e3sm.org/E3SM/pr-preview/pr-7415/ELM/tech-guide/shortwave_radiation. Let me try to fix them. |
This is the error message that I also got: ![]() But, after refreshing the browser, the equations were rendered correctly: ![]() @mahf708, any thoughts on what could be going on here? Is |
I think it is complaining about the fact that
Up to you if you want to reformulate these eqs (by breaking them) or if you want to ignore and just rely on people refreshing the page. Fwiw, I personally tend to not reference equations in docs I write. I tend to write docs less as a technical manuscript but more as a blog, for a friendly reader. I find equation numbering (and other formal stuff) to be a bit too formal for these types of docs. Obviously this is just a personal opinion. You can see how I tend to write docs in places like https://raw.githubusercontent.com/E3SM-Project/E3SM/refs/heads/master/components/eamxx/docs/user/diags/field_contraction.md and https://raw.githubusercontent.com/E3SM-Project/E3SM/refs/heads/master/components/eamxx/docs/technical/aerocom_cldtop.md. In other words, smaller pages targeting specific concepts, and nothing too complex/sprawling that would require careful eq referencing, etc. |
@mahf708, thanks for the comments and links. However, they are two different labels: |
Yeah, I noticed that. However, I think the error is simply because One more thing, try to ensure your markdown renders correctly even in plain markdown... i.e., check this file: And you will find this: ![]() |
Making sure the plain markdown is rendered correctly is a great suggestion. |
@peterdschwartz, I'm going to switch all |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
endosring integrating
Changes latex eqn to eqnref [BFB]
merged to next and master |
Changes
\eqn{}
to\eqref{}
.[BFB]