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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some typos and grammar. #582

Merged
merged 2 commits into from Apr 8, 2018
Merged

Conversation

maazadeeb
Copy link

Hi!

Thanks for making this awesome library. 馃帀 I noticed that there were a few typos and grammatical errors in the Popper docs. Also, I noticed that the docs are generated from the JSDocs. For now, I've edited the .md file directly in order to get your feedback. Once you're OK with the changes, I'll change the source files.

Things I've done:

  1. Corrected typos
  2. Highlighted some strings as code as they're referring to actual code
  3. Split some sentences into two to make them grammatically correct
  4. Normalized the placement of .s in the docs
    1. No .s in the doc tables
    2. .s at the end of API descriptions

@FezVrasta
Copy link
Member

Thanks the corrections look good, please go ahead.

@FezVrasta
Copy link
Member

Any news on this?

@maazadeeb
Copy link
Author

I have a local commit ready. Just a few final checks. Will update in a day or two

@maazadeeb maazadeeb changed the title [Need feedback] Fix some typos and grammar. Fix some typos and grammar. Apr 3, 2018
@maazadeeb
Copy link
Author

I didn't notice initially, but the generated docs have a weird ^M character. Is it expected or there is something that I'm missing here?

Also FYI, I'm on Windows.

@FezVrasta
Copy link
Member

Umh nope that's not expected, maybe it's some Windows quirk. May you get rid of the compiled markdown so that I can generate it once this PR is merged please?

@maazadeeb
Copy link
Author

Oh cool. I'll remove it.

@FezVrasta FezVrasta merged commit 74c011f into floating-ui:master Apr 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants