Skip to content

Conversation

@zverok
Copy link
Contributor

@zverok zverok commented Mar 25, 2018

Problems of the "intro" section of current documentation I am trying to solve:

  • It does not provide a generic overview of the class usage, diving straight into particular examples;
  • The overall structure, with a lot of headers and subheaders, which separate 1-2 line sections, is hard to read
  • The large part of functionality (data conversion and usage of headers to obtain CSV::Table/CSV::Row) is not mentioned in the intro at all. I constantly see students, juniors or even middle devs that use the library a lot yet still unaware of those parts of functionality.

@kou kou merged commit 6744d45 into ruby:master Mar 31, 2018
@kou
Copy link
Member

kou commented Mar 31, 2018

Thanks!

@zverok zverok deleted the update-main-docs branch April 1, 2018 15:43
@kou kou changed the title Update CVS documentation Update CSV documentation Jul 3, 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.

3 participants