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

Restructure performance tips #54211

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

gdalle
Copy link
Contributor

@gdalle gdalle commented Apr 23, 2024

This PR makes the documentation page on "performance tips" more accessible and structured.

Ping @abraemer, @adrhill, @jacobusmmsmit

  • Restructure the page into four main sections:
    1. General advice
    2. Type inference
    3. Memory management and arrays
    4. Miscellaneous
  • Increase subsection depth of individual items and move them into the appropriate category
  • Try to put the most important items first, and the least important last
  • Rename one header to unify style

No content has been modified, this is strictly copy-paste and moving things around

@LilithHafner
Copy link
Member

Copy link
Member

@LilithHafner LilithHafner left a comment

Choose a reason for hiding this comment

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

I think this is an overall improvement. There is certainly room for more, but I think @gdalle's decision to restrict this PR to exclusively rearrangement is a good one.

Unless someone thinks this is not an overall improvement, I'll go ahead and merge it.

@LilithHafner LilithHafner added domain:docs This change adds or pertains to documentation performance Must go faster labels Apr 23, 2024
@LilithHafner LilithHafner merged commit 9107bd3 into JuliaLang:master Apr 23, 2024
10 of 13 checks passed
@gdalle gdalle deleted the performance_tips_restructure branch April 25, 2024 06:10
LilithHafner pushed a commit that referenced this pull request Jul 25, 2024
There's a few reasons for making it public:
- It's already mentioned in the manual (#54211).
- It's the easiest way to deprecate a function that shouldn't be used
anymore at all.
- It's already widely used in the ecosystem:
https://juliahub.com/ui/Search?type=code&q=Base.depwarn(

I also moved the `@deprecate` docs into a new `Managing deprecations`
section because I felt it should go together with `Base.depwarn()`.
Might be worth backporting to 1.11?
lazarusA pushed a commit to lazarusA/julia that referenced this pull request Aug 17, 2024
There's a few reasons for making it public:
- It's already mentioned in the manual (JuliaLang#54211).
- It's the easiest way to deprecate a function that shouldn't be used
anymore at all.
- It's already widely used in the ecosystem:
https://juliahub.com/ui/Search?type=code&q=Base.depwarn(

I also moved the `@deprecate` docs into a new `Managing deprecations`
section because I felt it should go together with `Base.depwarn()`.
Might be worth backporting to 1.11?
KristofferC pushed a commit that referenced this pull request Aug 19, 2024
There's a few reasons for making it public:
- It's already mentioned in the manual (#54211).
- It's the easiest way to deprecate a function that shouldn't be used
anymore at all.
- It's already widely used in the ecosystem:
https://juliahub.com/ui/Search?type=code&q=Base.depwarn(

I also moved the `@deprecate` docs into a new `Managing deprecations`
section because I felt it should go together with `Base.depwarn()`.
Might be worth backporting to 1.11?

(cherry picked from commit 442f9d5)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation performance Must go faster
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants