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

Tweak simpify README #320

Merged
merged 1 commit into from
Dec 5, 2016
Merged

Conversation

existentialism
Copy link
Member

Adds line break in between examples (babel/website#1029) and fixes numbering.

else b();
}
```

Copy link
Member

Choose a reason for hiding this comment

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

Identation with code blocks seems to no work. Could you remove them ?

screenshot from 2016-12-04 18-36-22

@@ -2,9 +2,10 @@

This plugin will transform code in mainly two ways:

1. Reduce as much statements as possible into expressions
1\. Reduce as much statements as possible into expressions
Copy link
Member

Choose a reason for hiding this comment

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

why is this required ?

Copy link
Member Author

@existentialism existentialism Dec 5, 2016

Choose a reason for hiding this comment

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

It's a temporary workaround to get the numbering correct and prevent indention since it causes all sorts of wonkiness with both the nested text and code block, currently:

image

Copy link
Member

Choose a reason for hiding this comment

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

It looks like this is something that needs to be fixed on the website then.

Copy link
Member

Choose a reason for hiding this comment

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

Hmm. It's not in the readme on github as well. Cool ... Then we can simply use unordered lists instead of ordered ... Numbering isn't important

Copy link
Member Author

@existentialism existentialism Dec 5, 2016

Choose a reason for hiding this comment

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

It's fine, can revert that until we get a more robust fix in place. Just note that this isn't isolated to just the website, the numbering is off on npm and GitHub) due to the code block.

Copy link
Member

Choose a reason for hiding this comment

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

or even headings, maybe ? what do you think?

Copy link
Member

Choose a reason for hiding this comment

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

this isn't isolated to just the website

Yeah. Noticed it just now. do you think making it a heading would be better ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, that's definitely another option... howabout:

> Simplifies code for minification by reducing statements into expressions and making expressions and uniform where possible.

## Example

### Reduce statement into expression:

**In**
// code example

**Out**
// code example

### Make expression as uniform as possible for better compressibility:

**In**
// code example

**Out**
// code example

Copy link
Member

Choose a reason for hiding this comment

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

👍

@existentialism existentialism force-pushed the docs-simplify branch 2 times, most recently from dedbf05 to 1a982bd Compare December 5, 2016 15:36
@existentialism
Copy link
Member Author

@boopathi updated!

/cc: @xtuc @geordidearns

@@ -1,10 +1,13 @@
# babel-plugin-minify-simplify

This plugin will transform code in mainly two ways:
> Simplifies code for minification by reducing statements into expressions and making expressions and uniform where possible.
Copy link
Member

Choose a reason for hiding this comment

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

- and making expressions and uniform
+ and making expressions uniform

Copy link
Member Author

Choose a reason for hiding this comment

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

👍

@boopathi boopathi added the Tag: Docs Pull Request updating Documentation label Dec 5, 2016
Copy link
Member

@boopathi boopathi left a comment

Choose a reason for hiding this comment

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

LGTM.

@xtuc @geordidearns. do you have any comments before I merge this ?

@xtuc
Copy link
Member

xtuc commented Dec 5, 2016

Nice work, LGTM 👍

@boopathi boopathi merged commit a44ad9e into babel:master Dec 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Tag: Docs Pull Request updating Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants