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

Improve depiction of Latex text in docs #700

Merged
merged 4 commits into from
May 4, 2023

Conversation

glatterf42
Copy link
Member

@glatterf42 glatterf42 commented Mar 27, 2023

This PR simply writes \text{xyz} in Latex math mode in the docs where before it used to be xyz. This should improve the time page and the efficiency page.

How to review

  • Build the documentation and look at the changed pages

PR checklist

  • Continuous integration checks all ✅

@codecov
Copy link

codecov bot commented Mar 27, 2023

Codecov Report

Merging #700 (356cf2c) into main (6a74435) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #700   +/-   ##
=====================================
  Coverage   94.4%   94.4%           
=====================================
  Files         43      43           
  Lines       3449    3449           
=====================================
  Hits        3258    3258           
  Misses       191     191           

@glatterf42
Copy link
Member Author

On the time page, please check that the equations in example 5 are correct. What I'm wondering about in particular is why the discount factor for 1020 should not contain any information of the years 1000 to 1010, when in the first part it is explained that the discount should be cumulative. There are two options I can see here: either df_1020 should be based on df_1010, in which case the years should be calculated by (1010-1011) etc and df_1010 itself should appear in the equation. Or it should be cumulative from 1000 to 1020, in which case the equation should be twice as long (i.e., start with (1000-1001)).
I briefly looked into the logic behind these equations in general, the present value formula is new to me, but I didn't have the time yet to check if the calculation is done correctly (i.e., is the discount factor defined as PV/C following the definiton on wikipedia?). However, based on the success of MESSAGEix in general, I assume that is the case.

Also, SimpleHTTPServer seems to have moved to http.server, so I adapted the local-build instructions for the docs.

@glatterf42 glatterf42 self-assigned this Mar 28, 2023
@glatterf42 glatterf42 requested a review from khaeru May 3, 2023 11:43
@khaeru khaeru added this to the 3.7 milestone May 4, 2023
@khaeru khaeru force-pushed the fix_latex_in_docs branch from fe7c6b6 to 356cf2c Compare May 4, 2023 07:44
@glatterf42 glatterf42 merged commit 28537fd into iiasa:main May 4, 2023
@glatterf42 glatterf42 deleted the fix_latex_in_docs branch May 4, 2023 12:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants