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

Type-field documentation only shows up with the type itself is also documented #27091

Open
mauro3 opened this issue May 13, 2018 · 0 comments
Open
Labels
docsystem The documentation building system

Comments

@mauro3
Copy link
Contributor

mauro3 commented May 13, 2018

Consider:

               _                                                                                                                                                         
   _       _ _(_)_     |  A fresh approach to technical computing
  (_)     | (_) (_)    |  Documentation: https://docs.julialang.org
   _ _   _| |_  __ _   |  Type "?help" for help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 0.7.0-DEV.5095 (2018-05-12 22:13 UTC)
 _/ |\__'_|_|_|\__'_|  |  Commit 2a21849b10* (0 days old master)
|__/                   |  x86_64-pc-linux-gnu

julia> struct A
       "a"
       a
       end                                                                                                                                                               
                                                                                                                                                                         
help?> A.a                                                                                                                                                               
  A has fields a.                                                                                                                                                        
                                                                                                                                                                         

julia> "A" 
       struct A
       "a"
       a
       end                                                                                                                                                               
A                                                                                                                                                                        

help?> A.a # now the "a"-docs is retrieved:
  a

Not really important... Maybe best would be to throw an error in the first case.

Please add the docsystem label.

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

No branches or pull requests

2 participants