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

docs: show binding name for No documentation found for ... message #57093

Merged
merged 1 commit into from
Jan 20, 2025
Merged

docs: show binding name for No documentation found for ... message #57093

merged 1 commit into from
Jan 20, 2025

Conversation

aviatesk
Copy link
Member

Making it more informative.
E.g., the difference for help?> Base._wait is:

diff --git a/old b/new
index 87f9b2d43a..5fb065658a 100644
--- a/old
+++ b/new
@@ -5,7 +5,7 @@
   │
   │    •  `Base._wait`

-  No documentation found for private symbol.
+  No documentation found for private binding `Base._wait`.

   `Base._wait` is a `Function`.

@aviatesk aviatesk requested a review from LilithHafner January 18, 2025 11:06
LilithHafner
LilithHafner approved these changes Jan 18, 2025
View reviewed changes
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.

Yes, thank you. And in general, publicity is defined at a per-binding level, not a per-symbol level.

@LilithHafner LilithHafner added the merge me PR is reviewed. Merge when all tests are passing label Jan 18, 2025
@LilithHafner LilithHafner mentioned this pull request Jan 18, 2025
Open
@giordano
Copy link
Contributor

This breaks lots of tests, including in Revise

@giordano giordano removed the merge me PR is reviewed. Merge when all tests are passing label Jan 18, 2025
@nsajko nsajko added the REPL Julia's REPL (Read Eval Print Loop) label Jan 19, 2025
@aviatesk
docs: show binding name for No documentation found for ... message
6e74315 
Making it more informative.
E.g., the difference for `help?> Base._wait` is:
```diff
diff --git a/old b/new
index 87f9b2d43a..5fb065658a 100644
--- a/old
+++ b/new
@@ -5,7 +5,7 @@
   │
   │    •  `Base._wait`

-  No documentation found for private symbol.
+  No documentation found for private binding `Base._wait`.

   `Base._wait` is a `Function`.
```
@aviatesk aviatesk force-pushed the avi/doc-binding-info branch from 3db0329 to 6e74315 Compare January 19, 2025 15:22
aviatesk added a commit to timholy/Revise.jl that referenced this pull request Jan 19, 2025
@aviatesk
update for JuliaLang/julia#57093
0968ea7
aviatesk added a commit to timholy/Revise.jl that referenced this pull request Jan 20, 2025
@aviatesk
update for JuliaLang/julia#57093 (#885)
f0b30e7
@aviatesk
Copy link
Member Author

Fixed up the tests, so going to merge this, xref: timholy/Revise.jl#885

@aviatesk aviatesk merged commit 2ca125f into master Jan 20, 2025
5 of 7 checks passed
@aviatesk aviatesk deleted the avi/doc-binding-info branch January 20, 2025 01:26
@inkydragon
Copy link
Member

Revise tests still broken.

Changing docstring: Test Failed at /root/.julia/packages/Revise/eZwqT/test/runtests.jl:1115
  Expression: get_docstring(ds) in ("No documentation found.", "No documentation found for private symbol.", "No documentation found for private binding.")
   Evaluated: "No documentation found for private binding " in ("No documentation found.", "No documentation found for private symbol.", "No documentation found for private binding.")

https://buildkite.com/julialang/julia-master/builds/43885#01948177-a1dc-443a-899f-3f0aef30816b/801-1009

@aviatesk

@aviatesk
Copy link
Member Author

aviatesk commented Jan 20, 2025 •
edited
Loading

Thanks, I fixed up the tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LilithHafner LilithHafner LilithHafner approved these changes

Assignees
No one assigned
Labels
REPL Julia's REPL (Read Eval Print Loop)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aviatesk @giordano @inkydragon @LilithHafner @nsajko