Conversation
return is a keyword, not a function, so using it like
return (expression);
rather than just
return expression;
is sub-optimal in a few ways:
- it seems to indicate a function call, which is not correct.
- it breaks with the most common style of use in the code base.
- the extra parentheses do nothing and could potentially be confusing.
This commit removes the redundant parens.
Sections in README.md are separated by two blank lines, except in one location where 3 blank lines are used - remove the extra blank line.
|
The lines on top of the HTML file are special. It is indeed invalid, but the page is still displayed by the browser and it was the most The documentation needs to be generated for 2 use cases:
For the website the documentation needs additional header and footer code to fit in. The navigation bar from the website should still be there for example, so that you can go back to other parts of the website while you visit the online documentation. The documentation generated locally can't use the website layout though. So there would need to exist 2 separate versions of the documentation that aren't compatible. Or so you would think... Every page on the website is processed by Jekyll if it starts with a YAML header. An empty YAML header consists of 2 lines of "---", which is what you found in doc/header.html. The header file contains some really hacky lines such that it will include other files when parsed by Jekyll, but has all that code inside HTML comments when opening the .html file directly. This allows me to use the exact same documentation files for both use cases. When I need to update the website, I literally copy the locally generated files without any modifications. The downside to this solution was that |
|
Thank you for explaining. |
jjuhl
force-pushed
the
various-small-fixups
branch
from
d0b5a78 to
4777330
Compare
|
PR updated with the HTML commit dropped. |
2 participants
Yet another small batch of small fixups for you to consider :)