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.

Sign up for GitHub

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

Jump to bottom

code_warntype docs: more neutral reference to @code_warntype #51361

Merged
merged 6 commits into from
Feb 8, 2024
Merged

code_warntype docs: more neutral reference to @code_warntype #51361

merged 6 commits into from
Feb 8, 2024

Conversation

ulysses4ever
Copy link
Contributor

fix #51358

@ulysses4ever ulysses4ever mentioned this pull request Sep 17, 2023
Closed
@brenhinkeller brenhinkeller added the domain:docs This change adds or pertains to documentation label Sep 17, 2023
@christiangnrd
Copy link
Contributor

christiangnrd commented Sep 18, 2023 •
edited
Loading

I don’t think the old reference should be completely removed as when accessing it from the docs, it links to https://docs.julialang.org/en/v1/manual/performance-tips/#man-code-warntype which actually does have more information.

Maybe rewording it to make it clear that it’s linking to a section of the Performance Tips page in the manual would be more helpful.

@christiangnrd
Copy link
Contributor

christiangnrd commented Sep 18, 2023 •
edited
Loading

Maybe something like

See the @code_warntype section in the Performance Tips page of the manual for more information.

@KristofferC
Copy link
Sponsor Member

Yes, (as was more or less already sais) the issue is that from the terminals p.o.v it looks like this is a link to the @code_warntype symbol and not the a particular section in the manual. Updating the line as @christiangnrd says seems better indeed.

@ulysses4ever
Copy link
Contributor Author

I updated it as suggested.

@christiangnrd
Copy link
Contributor

You want to modify line 73 without removing line 75.

@ulysses4ever
Copy link
Contributor Author

My bad. Another attempt is in.

fingolfin
fingolfin approved these changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Looks good to me, thanks!

@fingolfin fingolfin added status:merge me PR is reviewed. Merge when all tests are passing backport 1.10 Change should be backported to the 1.10 release labels Feb 8, 2024
@KristofferC KristofferC merged commit 5cb5cd8 into JuliaLang:master Feb 8, 2024
6 of 9 checks passed
@inkydragon inkydragon removed the status:merge me PR is reviewed. Merge when all tests are passing label Feb 8, 2024
@KristofferC KristofferC mentioned this pull request Feb 20, 2024
Merged
19 tasks
KristofferC pushed a commit that referenced this pull request Feb 26, 2024
@ulysses4ever @KristofferC
code_warntype docs: more neutral reference to @code_warntype (#51361)
81a0d42 
fix #51358

---------

Co-authored-by: Fredrik Ekre <ekrefredrik@gmail.com>
Co-authored-by: Max Horn <max@quendi.de>
(cherry picked from commit 5cb5cd8)
KristofferC pushed a commit that referenced this pull request Feb 26, 2024
@ulysses4ever @KristofferC
code_warntype docs: more neutral reference to @code_warntype (#51361)
5ae8707 
fix #51358

---------

Co-authored-by: Fredrik Ekre <ekrefredrik@gmail.com>
Co-authored-by: Max Horn <max@quendi.de>
(cherry picked from commit 5cb5cd8)
KristofferC added a commit that referenced this pull request Feb 27, 2024
@KristofferC
Backports for 1.10.2 (#53405)
997b49f 
Backported PRs:
- [x] #53205 <!-- Profile: add notes to `print()` docs -->
- [x] #53170 <!-- Remove outdated discussion about externally changing
module bindings -->
- [x] #53228 <!-- SubArray: avoid invalid elimination of singleton
indices -->
- [x] #51361 <!-- code_warntype docs: more neutral reference to
@code_warntype -->
- [x] #50480 <!-- Document --heap-size-hint in Command-line Interface
-->
- [x] #53301 <!-- Fix typo in `Sys.total_memory` docstring. -->
- [x] #53354 <!-- fix code coverage bug in tail position and `else` -->
- [x] #53388 <!-- Fix documentation: thread pool of main thread -->
- [x] #53429 <!-- Subtype: skip slow-path in `local_∀_∃_subtype` if
inputs contain no ∃ typevar. -->
- [x] #53437 <!-- Add debug variant of loader_trampolines.o -->

Need manual backport:
- [ ] #52505 <!-- fix alignment of emit_unbox_store copy -->
- [ ] #53373 <!-- fix sysimage-native-code=no option with pkgimages -->
- [ ] #53439 <!-- staticdata: fix assert from partially disabled native
code -->

Contains multiple commits, manual intervention needed:
- [ ] #52913 <!-- Added docstring for Artifacts.jl -->
- [ ] #53218 <!-- Fix interpreter_exec.jl test -->

Non-merged PRs with backport label:
- [ ] #53424 <!-- yet more atomics & cache-line fixes on work-stealing
queue -->
- [ ] #53125 <!-- coverage: count coverage where explicitly requested by
inference only -->
- [ ] #52694 <!-- Reinstate similar for AbstractQ for backward
compatibility -->
- [ ] #51479 <!-- prevent code loading from lookin in the versioned
environment when building Julia -->
@KristofferC KristofferC removed the backport 1.10 Change should be backported to the 1.10 release label Mar 12, 2024
Drvi pushed a commit to RelationalAI/julia that referenced this pull request Jun 7, 2024
@ulysses4ever @Drvi
code_warntype docs: more neutral reference to @code_warntype (JuliaLa…
0cf9515 
…ng#51361)

fix JuliaLang#51358

---------

Co-authored-by: Fredrik Ekre <ekrefredrik@gmail.com>
Co-authored-by: Max Horn <max@quendi.de>
(cherry picked from commit 5cb5cd8)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KristofferC KristofferC KristofferC left review comments

@fingolfin fingolfin fingolfin approved these changes

Assignees
No one assigned
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for code_warntype tells to look for @code_warntype but that one is useless
7 participants
@ulysses4ever @christiangnrd @KristofferC @fingolfin @inkydragon @brenhinkeller @fredrikekre