<< Back to previous view

[DCSV-17] Adding namespace qualifiers in documentation Created: 11/Nov/17  Updated: 12/Nov/17

Status: Open
Project: data.csv
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Defect Priority: Minor
Reporter: Ash Assignee: Jonas Enlund
Resolution: Unresolved Votes: 0
Labels: documentation


 Description   

README.md has code examples that are missing namespace qualifiers, Adding them will make it easy to copy the code in REPL and make it work.
In addition to that there are couple of fixes for misspelled words.
The commit is in the following fork for reference

https://raw.githubusercontent.com/as17237/data.csv/master/README.md



 Comments   
Comment by Jonas Enlund [ 12/Nov/17 8:25 AM ]

Have you signed the contributor agreement (https://clojure.org/community/contributing )? I would be happy accepting a patch (https://dev.clojure.org/display/community/Developing+Patches ) if you have.





[DCSV-10] Specify RFC4180 compatibilty in README Created: 18/Mar/15  Updated: 19/Mar/15

Status: Open
Project: data.csv
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major
Reporter: Leon Grapenthin Assignee: Jonas Enlund
Resolution: Unresolved Votes: 0
Labels: documentation


 Description   

In the README it says: "Follows the RFC4180 specification but is more relaxed."
This is an oxymoron and confusing in other regards. E.g.:

  • What does "relaxed" mean?
  • If it is more "relaxed" than the specification, how can it follow it?
  • Does it follow the specification, or only parts of it?

Problem: If I use this lib to generate CSV for a third party, can I say "This is RFC4180 conform CSV" and feel safe with it? Or should I add "but it is more relaxed"

The task could be to add more specific explanation or a comparison table if necessary.



 Comments   
Comment by Jonas Enlund [ 18/Mar/15 10:54 AM ]

"relaxed" means it will read some files that does not adhere to the RFC4180 spec. Files written with write-csv will follow the spec. If this is not the case it should be considered a bug.

Comment by Leon Grapenthin [ 19/Mar/15 5:13 AM ]

Thanks for the explanation.
Then it should be pointed out in which regards read CSVs don't need to adhere to the spec and whether a strict mode exists or is planned and whether it is or will or would be more or less performant.

P.S.: Out of curiosity - Is this definition of relaxed some kind of standard in IT? I googled for it, but couldn't find anything related.

Comment by Jonas Enlund [ 19/Mar/15 5:33 AM ]

According to the RFC4180 spec:

  • the lines should end with CRLF, this library also supports only LF as well
  • cells should be separated with commas and this lib also supports other separators

I don't think "relaxed" is a standard term. I would certainly accept a patch that enhances the documentation.





[DCSV-3] Some minor documentation typos Created: 14/Jun/12  Updated: 15/Jun/12  Resolved: 15/Jun/12

Status: Resolved
Project: data.csv
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Defect Priority: Trivial
Reporter: Trent Ogren Assignee: Jonas Enlund
Resolution: Completed Votes: 0
Labels: docs, documentation, typo

Attachments: Text File 0001-Documentation-typo-fixes.patch    
Patch: Code

 Description   

I found a couple minor typos: one in the README, one in a docstring. I've included a patch.






Generated at Sat Jan 20 13:28:54 CST 2018 using JIRA 4.4#649-r158309.