Skip to content

Enhanced Rdoc for CSV#122

Merged
kou merged 24 commits intoruby:masterfrom
BurdetteLamar:master
May 12, 2020
Merged

Enhanced Rdoc for CSV#122
kou merged 24 commits intoruby:masterfrom
BurdetteLamar:master

Conversation

@BurdetteLamar
Copy link
Member

@BurdetteLamar BurdetteLamar commented May 7, 2020

I've begun working on enhanced rdoc for CSV. Mostly, I'm interested in adding example code, beginning with the options.

I'm creating this PR to give The Powers That Be a chance to warn me if they are not interested in this work.

@kou
Copy link
Member

kou commented May 8, 2020

Thanks.
I've added support for generating RDoc by Rake on master.
Could you rebase on master when this is ready to be reviewed?

@BurdetteLamar
Copy link
Member Author

13/21 options done, + a few odds and ends. For me, git rebase is deep and dark. Can I save my files, make a new fork/clone, then restore my files? Does that work?

Oh, and thanks for your interest.

@kou
Copy link
Member

kou commented May 9, 2020

OK.
I'll do it. Please notify me when you complete this.

@BurdetteLamar BurdetteLamar marked this pull request as ready for review May 9, 2020 21:49
@BurdetteLamar
Copy link
Member Author

I think this is good enough for you to look at.

  • This has few changes outside of options. (Other stuff later.)
  • I used #fetch, not #[] to show the option defaults, b/c it gives an error if not found.
  • The options are in the order you already had (I think).

@BurdetteLamar
Copy link
Member Author

@kou, the tests did not work on my machine. Old error, I think. I ran 'rake test'.

@BurdetteLamar BurdetteLamar marked this pull request as draft May 10, 2020 13:26
@BurdetteLamar
Copy link
Member Author

A few more things to do for options.

@BurdetteLamar BurdetteLamar marked this pull request as ready for review May 10, 2020 17:29
@BurdetteLamar
Copy link
Member Author

@kou, ready when you are.

@BurdetteLamar BurdetteLamar marked this pull request as draft May 11, 2020 15:13
@BurdetteLamar
Copy link
Member Author

Back to draft; working on converters.

@BurdetteLamar BurdetteLamar marked this pull request as ready for review May 12, 2020 15:41
@BurdetteLamar
Copy link
Member Author

@kou, ready for you. I will not push anything more (except very minor corrections) until we've had a chance to begin review/remark/rework/repush. Suggest we do this piecemeal, maybe beginning with one or two options at a time?

@BurdetteLamar BurdetteLamar changed the title Draft: Enhanced Rdoc for CSV options Enhanced Rdoc for CSV May 12, 2020
@kou
Copy link
Member

kou commented May 12, 2020

I've rebased and reverted code changes. Because the code changes break our CI.

It was good that we create a pull request per option but we already did for many options.
I couldn't review this large change. I'll merge this time.
We can improve documents we added as follow-up pull requests.

@kou kou merged commit cd67059 into ruby:master May 12, 2020
@topstone topstone mentioned this pull request May 17, 2020
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.

2 participants