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

Convert markup generation to a function #43236

Merged
merged 2 commits into from
Apr 29, 2022
Merged

Conversation

eschnett
Copy link
Contributor

Using a function to generate markup ensures that its temporary variables (e.g. str) are not visible any more later on, avoiding compiler warnings.

Using a function to generate markup ensures that its temporary variables (e.g. `str`) are not visible any more later on, avoiding compiler warnings.
@dkarrasch dkarrasch added the docsystem The documentation building system label Nov 28, 2021
Copy link
Member

@vtjnash vtjnash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you just want a let basename = "NEWS" block here (since the goal seems to be avoiding introducing unnecessary new global names)?

Co-authored-by: woclass <[email protected]>
@inkydragon
Copy link
Member

inkydragon commented Apr 29, 2022

@vtjnash
I am going to add HISTORY.md to the documentation as well.
So defining a new function now looks acceptable.
I just need to add a new line of function calls: generate_markdown("HISTORY")

After some trying, I found that the generate_markdown function actually only applies to NEWS.md so it may not be necessary to define a separate function.

Using let is indeed a more proper way.

-function generate_markdown(basename)
+let basename = "NEWS"

...

end
-generate_markdown("NEWS")

Can we merge this pr now?
cc: @ViralBShah

@ViralBShah
Copy link
Member

@vtjnash Can we merge?

@ViralBShah
Copy link
Member

Actually this is pretty straightforwad. Merging.

@ViralBShah ViralBShah merged commit 6026b5f into JuliaLang:master Apr 29, 2022
@eschnett eschnett deleted the patch-6 branch August 14, 2023 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants