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

docs for showcompact and array printing #14575

Closed
ssfrr opened this issue Jan 6, 2016 · 2 comments
Closed

docs for showcompact and array printing #14575

ssfrr opened this issue Jan 6, 2016 · 2 comments
Labels
domain:docs This change adds or pertains to documentation

Comments

@ssfrr
Copy link
Contributor

ssfrr commented Jan 6, 2016

The current docs for showcompact say:

Show a more compact representation of a value. This is used for printing array elements.

In print_matrix_repr, compactness is determined by array_eltype_show_how(X), which ends up only being compact if isleaftype(T) && (T<:Number || T<:AbstractString)

I wanted to clarify expected behavior. I came across this because I'm defining a non-numeric type that I want to display more compactly when in a vector, and initially thought I could just define showcompact.

Given #14052 this may soon become a moot point, so feel free to say so and close if it's not worth worrying about.

EDIT: I just realized that showcompact is used by writemime when displaying to the REPL, so I'm guessing that's what the note in the docstring is referring to.

@ssfrr
Copy link
Contributor Author

ssfrr commented Jan 6, 2016

also, I'm happy to either update the docs or the implementation once I know what the right direction is, and if it's not about to be imminently clobbered.

@tkelman tkelman added the domain:docs This change adds or pertains to documentation label Jan 6, 2016
@JeffBezanson
Copy link
Sponsor Member

The help for showcompact now explains how to deal with it. This is also part of #5709.

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
Projects
None yet
Development

No branches or pull requests

3 participants