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.

Sign up for GitHub

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

Jump to bottom

Improve readability of Float::Printer::* docs #5438

Merged
merged 1 commit into from Sep 25, 2018
Merged

Improve readability of Float::Printer::* docs #5438

merged 1 commit into from Sep 25, 2018

Conversation

Sija
Copy link
Contributor

@Sija Sija commented Dec 22, 2017

ATM docs for Float::Printer modules are quite unreadable (see for instance Float::Printer::Grisu3#digit_gen), this PR improves that.

@larubujo
Copy link
Contributor

Float::Printer should be hidden from docs imo, just internal impl

@RX14
Copy link
Contributor

RX14 commented Dec 22, 2017

Agreed, but they should be documented for developers nonetheless

@Sija
Copy link
Contributor Author

Sija commented Dec 22, 2017

# :nodoc: it?

@asterite
Copy link
Member

@Sija Could you :nodoc: it?

@Sija Sija force-pushed the float-printer-docs-polish branch from 4f0859c to 0637870 Compare August 31, 2018 17:19
@Sija
Copy link
Contributor Author

Sija commented Aug 31, 2018

Since #6627 has been merged, I've pushed an update with :nodoc:-ed comments. Please, let me know if there are any more needed to be :nodoc:-ed.

@RX14
Copy link
Contributor

RX14 commented Aug 31, 2018

No, the whole of Float::Printer should be :nodoc:

@Sija Sija force-pushed the float-printer-docs-polish branch from 0637870 to 45d2e83 Compare August 31, 2018 22:42
@Sija
Copy link
Contributor Author

Sija commented Aug 31, 2018

@RX14 done.

@Sija
Copy link
Contributor Author

Sija commented Sep 13, 2018

ping

@Sija
Copy link
Contributor Author

Sija commented Sep 22, 2018

Is there anything more TBD here? Aside of merging...?

@RX14
Copy link
Contributor

RX14 commented Sep 22, 2018

another review

@Sija
Copy link
Contributor Author

Sija commented Sep 24, 2018

2nd review, @bcardiff @asterite, anyone?

@RX14 RX14 added this to the 0.27.0 milestone Sep 25, 2018
@RX14 RX14 merged commit 8dc406f into crystal-lang:master Sep 25, 2018
ezrast pushed a commit to ezrast/crystal that referenced this pull request Oct 2, 2018
@Sija
Improve readability of Float::Printer::* docs (crystal-lang#5438)
8bff13f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RX14 RX14 RX14 approved these changes

Assignees
No one assigned
Labels
kind:docs kind:feature topic:stdlib
Projects
None yet
Milestone
0.27.0
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@Sija @larubujo @RX14 @asterite