Skip to content

feat: add a stdlib ASCII art in REPL's default welcome message #2178

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

Merged
merged 2 commits into from
Apr 17, 2024

Conversation

Snehil-Shah
Copy link
Member

@Snehil-Shah Snehil-Shah commented Apr 16, 2024

Resolves #2175

Description

What is the purpose of this pull request?

This pull request adds a stdlib ASCII art in the default welcome message of the REPL.

Some design combinations I tried are attached below:

  • Julia type partitioning

    • Current implementation:
      julia_std

    • We can add/remove more spaces to make it more spread-out/compact:
      julia_std_nospace
      julia_std_spacetop

    • A Tall typeface:
      julia_tall

  • Simple design

    simple_nospace

  • A dramatic design I made myself (personally, not a fan)

    dramatic_1
    dramatic_2

@kgryte all yours to choose... I prefer the current implementation or a more compact version of it

There are various other fonts available here too, although most are a bit too dramatic for a REPL application IMO...
If we are looking for even smaller arts, rectangles, small etc are some of the good fonts

We can also explore incorporating some colors into our welcome message, now or in the future...

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

Can we shorten the text 'For more info about stdlib, see the source repository:' to just 'For more info, see the source repository:' or 'see the source repository:'? It better aligns with the rest of the block giving us a fixed width as attached below:

image

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

Signed-off-by: Snehil Shah <snehilshah.989@gmail.com>
@kgryte
Copy link
Member

kgryte commented Apr 16, 2024

@Snehil-Shah The first design is good. And yes to abbreviating the "For more info,".

@kgryte kgryte added Enhancement Issue or pull request for enhancing existing functionality. REPL Issue or pull request specific to the project REPL. labels Apr 16, 2024
@kgryte
Copy link
Member

kgryte commented Apr 16, 2024

I think you either want the vertical dashed line to either align with the API descriptions OR the tag text to align with the API descriptions.

@kgryte
Copy link
Member

kgryte commented Apr 16, 2024

In the last screenshot in "Questions", you don't have either, so can appear misaligned.

@Snehil-Shah
Copy link
Member Author

Snehil-Shah commented Apr 16, 2024

@kgryte Personally, they don't appear misaligned to me, as the API docs and the art above are two different entities which themselves look pretty symmetrical on their own.

image

Here are the designs after trying to align them. Looks good too:

image

With equal spacing around the vertical line. Honestly looks cluttered:

image

Aligning the vertical line looks worse imo:

image

What do you prefer?

@kgryte
Copy link
Member

kgryte commented Apr 16, 2024

Let's go with the first. That is what is currently implemented in this PR, correct?

Signed-off-by: Snehil Shah <snehilshah.989@gmail.com>
@Snehil-Shah
Copy link
Member Author

@kgryte This is currently implemented:

image

If by first, you meant this, then this PR is good to go👍

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks, @Snehil-Shah!

@kgryte kgryte merged commit ebd3878 into stdlib-js:develop Apr 17, 2024
@Snehil-Shah Snehil-Shah deleted the ascii-art branch April 17, 2024 01:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement Issue or pull request for enhancing existing functionality. REPL Issue or pull request specific to the project REPL.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: add stdlib ASCII art in REPL's default welcome message
2 participants