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

pub: plain text README should not look "hideous" #8732

Closed
jmesserly opened this issue Feb 22, 2013 · 10 comments
Closed

pub: plain text README should not look "hideous" #8732

jmesserly opened this issue Feb 22, 2013 · 10 comments
Labels
P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug

Comments

@jmesserly
Copy link

On Fri, Feb 22, 2013 at 12:36 PM, Justin Fagnani <justinfagnani@google.com> wrote:
> Here you go, all pubified: http://pub.dartlang.org/packages/appengine_channel
>
> (Yes, I need to put change the README to markdown, it looks hideous)
>
> Let me know if there are any problems.

@jmesserly
Copy link
Author

I noticed this too when analyzer_experimental has a non-markdown README

@munificent
Copy link
Member

There isn't too much we can do here. It needs to be a monospace font because plaintext readme's often use whitespace for alignment. We need to frame it in case it has long lines that would overlap the rest of the pub UI.

Given those constraints, what do you think would look better?


Added this to the Later milestone.
Removed Type-Defect label.
Added Type-Enhancement label.

@jmesserly
Copy link
Author

Here are a few ideas:

  1. intelligent line wrapping. If you know what's a paragraph you can format better
  2. make the default width+font size able to handle typical readme's (it seems to have very few cols right now)
  3. add a horizontal scrollbar. maybe a heuristic to tell if the plain text looks line broken or not
  4. just pretend it's markdown. it'll probably render okay

@DartBot
Copy link

DartBot commented May 5, 2013

This comment was originally written by amouravski@google.com


Added Community-StarterBug label.

@munificent
Copy link
Member

Removed Area-Pub label.
Added Area-PubSite label.

@kasperl
Copy link

kasperl commented Jul 10, 2014

Removed this from the Later milestone.
Added Oldschool-Milestone-Later label.

@srawlins
Copy link
Member

This has been fixed. This can be closed.

@kasperl
Copy link

kasperl commented Aug 4, 2014

Removed Oldschool-Milestone-Later label.

@nicolasgarnier
Copy link
Contributor

This issue has been moved to Github as part of a migration. Please use the Issue on Github going forward: https://github.com/dart-lang/pub-dartlang/issues


Added MovedToGithub label.

@DartBot
Copy link

DartBot commented Jun 5, 2015

This issue has been moved to dart-archive/pub-dartlang#318.

@kevmoo kevmoo added type-enhancement A request for a change that isn't a bug and removed type-enhancement labels Mar 1, 2016
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 A lower priority bug or feature request type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

7 participants