Skip to content
This repository has been archived by the owner on Feb 22, 2018. It is now read-only.

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

Closed
DartBot opened this issue Jun 5, 2015 · 9 comments
Closed

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

DartBot opened this issue Jun 5, 2015 · 9 comments

Comments

@DartBot
Copy link

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/1081711?v=3" align="left" width="96" height="96"hspace="10"> Issue by jmesserly
Originally opened as dart-lang/sdk#8732


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.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/1081711?v=3" align="left" width="48" height="48"hspace="10"> Comment by jmesserly


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

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/46275?v=3" align="left" width="48" height="48"hspace="10"> Comment by munificent


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.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/1081711?v=3" align="left" width="48" height="48"hspace="10"> Comment by jmesserly


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
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/264967?v=3" align="left" width="48" height="48"hspace="10"> Comment by amouravski


Added Community-StarterBug label.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/46275?v=3" align="left" width="48" height="48"hspace="10"> Comment by munificent


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

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/2156198?v=3" align="left" width="48" height="48"hspace="10"> Comment by kasperl


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

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/103167?v=3" align="left" width="48" height="48"hspace="10"> Comment by srawlins


This has been fixed. This can be closed.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/2156198?v=3" align="left" width="48" height="48"hspace="10"> Comment by kasperl


Removed Oldschool-Milestone-Later label.

@DartBot
Copy link
Author

DartBot commented Jun 5, 2015

<img src="https://avatars.githubusercontent.com/u/3766663?v=3" align="left" width="48" height="48"hspace="10"> Comment by nicolasgarnier


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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

1 participant