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

Substantial overhaul of the tutorial page #313

Merged
merged 31 commits into from
Nov 21, 2022

Conversation

Ininterrompue
Copy link
Contributor

@Ininterrompue Ininterrompue commented Nov 19, 2022

This PR rewrites large parts of tutorial.md which I thought were not explained well enough or did not use enough examples. The motivation is that most new users of Julia will inevitably want to plot something, so the explanations should be geared towards beginner programmers, i.e. as elementary as possible, so the symbol syntax : and macro @. were mentioned. Sections on saving figures and logarithmic axes were added.

Most important for me was giving plenty of examples for common attributes, as well as plotting sensible functions instead of random data. The backends section was pushed further down as I felt that the discussion on scatter plots should be given greater importance for beginners.

Fix #132.

@t-bltg
Copy link
Member

t-bltg commented Nov 19, 2022

Thanks for enhancing this.

Ping us when ready for review / merge.

@Ininterrompue
Copy link
Contributor Author

@t-bltg It is ready now.

docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Show resolved Hide resolved
docs/src/tutorial.md Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
@t-bltg
Copy link
Member

t-bltg commented Nov 19, 2022

Can you search through the existing issues the ones that this PR fixes and Fix: <issue> in #313 (comment) so that they will auto-magically be closed upon merge of this PR ?

I've added #132 for example.

@Ininterrompue
Copy link
Contributor Author

Ininterrompue commented Nov 19, 2022

PR doesn't fix other issues. #55 and #74 are relevant, but I only lightly edited that Recipes section. Recipes eventually needs its own page. Actually, it looks like #55 should already be resolved.

@t-bltg
Copy link
Member

t-bltg commented Nov 19, 2022

Nice, thanks, closing #55.

Copy link
Member

@BeastyBlacksmith BeastyBlacksmith left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! I only got some minor remarks.

docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Show resolved Hide resolved
docs/src/tutorial.md Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
docs/src/tutorial.md Outdated Show resolved Hide resolved
@Ininterrompue
Copy link
Contributor Author

@BeastyBlacksmith Thanks for reviewing. Most of the suggestions have been incorporated.

@BeastyBlacksmith BeastyBlacksmith merged commit 115037a into JuliaPlots:master Nov 21, 2022
Ininterrompue added a commit to Ininterrompue/PlotDocs.jl that referenced this pull request Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing info about LaTeX texts
3 participants