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

complete function signature for varinfo #48852

Merged
merged 1 commit into from
Mar 2, 2023
Merged

complete function signature for varinfo #48852

merged 1 commit into from
Mar 2, 2023

Conversation

udohjeremiah
Copy link
Contributor

The varinfo function doc says:

  varinfo(m::Module=Main, pattern::Regex=r""; all::Bool = false, imported::Bool = false, sortby::Symbol = :name, minsize::Int = 0)

  Return a markdown table giving information about exported global variables
  in a module, optionally restricted to those matching pattern.

  The memory consumption estimate is an approximate lower bound on the size of
  the internal structure of the object.

    •  all : also list non-exported objects defined in the module,
       deprecated objects, and compiler-generated objects.

    •  imported : also list objects explicitly imported from other
       modules.

    •  recursive : recursively include objects in sub-modules, observing
       the same settings in each.

    •  sortby : the column to sort results by. Options are :name
       (default), :size, and :summary.

    •  minsize : only includes objects with size at least minsize bytes.
       Defaults to 0.

While the keyword recursive was added to the parameters explained, it was not added to the function docs. This PR corrects the mistake.

@udohjeremiah udohjeremiah added the docs This change adds or pertains to documentation label Mar 2, 2023
@LilithHafner
Copy link
Member

Thanks!

@LilithHafner LilithHafner merged commit dbcac43 into JuliaLang:master Mar 2, 2023
@udohjeremiah udohjeremiah deleted the patch-1 branch March 2, 2023 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants