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

Should * or i be used for footer information? #627

Closed
DavisVaughan opened this issue Feb 15, 2023 · 11 comments · Fixed by #635
Closed

Should * or i be used for footer information? #627

DavisVaughan opened this issue Feb 15, 2023 · 11 comments · Fixed by #635

Comments

@DavisVaughan
Copy link
Member

With #617 we now use bullets for separating footer information like

image

Did we ever consider using i for this instead? In most of our error / warning messaging, we now use i to convey a general "info bullet" and it seems like this might fall in that category.

@lionel- do you have any thoughts about i vs * here?

@lionel-
Copy link
Member

lionel- commented Feb 16, 2023

I think so too.

By the way, did we consider standardising the header to use the conventional angular brackets?

@krlmlr
Copy link
Member

krlmlr commented Feb 16, 2023

Like this?

# A tibble: [2,196 x 11]

@lionel-
Copy link
Member

lionel- commented Feb 16, 2023

Like

#> <tibble [2,196 x 11]>

I think tibble is about the only place where we use a # header?

@krlmlr
Copy link
Member

krlmlr commented Feb 16, 2023

How would we print a multiline header?

@lionel-
Copy link
Member

lionel- commented Feb 16, 2023

I think we'd use the conventional approach and wouldn't have a multiline header? More information could be displayed in bullets instead? But I don't know in what cases tibble uses multiline headers.

@krlmlr
Copy link
Member

krlmlr commented Feb 16, 2023

In subclasses of "tbl":

dbplyr::memdb_frame(a = 1)
#> # Source:   table<dbplyr_001> [1 x 1]
#> # Database: sqlite 3.40.1 [:memory:]
#>       a
#>   <dbl>
#> 1     1

Created on 2023-02-16 with reprex v2.0.2

@lionel-
Copy link
Member

lionel- commented Feb 16, 2023

Following for instance the rlang_error formatting, this could be:

#> <table<dbplyr_001> [1 x 1]>
#> Database: sqlite 3.40.1 [:memory:]
#>       a
#>   <dbl>
#> 1     1

@DavisVaughan
Copy link
Member Author

DavisVaughan commented Feb 16, 2023

@hadley requested we keep it as # back here #542 (comment)

Changing it would probably be fairly disruptive to subclass authors who have provided extra # lines in their headers, like tsibble and data base backends

@krlmlr
Copy link
Member

krlmlr commented Mar 12, 2023

Closing, please reopen/comment if this was bad judgment.

@krlmlr krlmlr closed this as completed Mar 12, 2023
@lionel-
Copy link
Member

lionel- commented Mar 12, 2023

No info bullets then?

@krlmlr
Copy link
Member

krlmlr commented Mar 12, 2023

Right, we can try info bullets.

@krlmlr krlmlr reopened this Mar 12, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Mar 16, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants