Rework documentation of std.zip. #7255
Conversation
std/zip.d
Outdated
|
|
||
| Standards: | ||
|
|
||
| The current implementation mostly conforms to $(LINK2 https://www.iso.org/standard/60101.html, ISO/IEC 21320-1:2015), |
There was a problem hiding this comment.
I write "mostly", because there might be some nonconformation left due to UTF8 issues or with the flags. I'm not totally in this currently, but have to investigate soon for fixing some further bugs.
std/zip.d
Outdated
| unpack algorithm) | ||
| ) | ||
|
|
||
| The current implementation makes use of the etc.c.zlib compression library. |
There was a problem hiding this comment.
I'm not sure, if this is still correct. The implementation uses std.zlib, which probably is based on etc.c.zlib. I'm not sure if this comment is of any help, but it was in the original documentation and so I decided to preserve it.
There was a problem hiding this comment.
Neither etc.c.zlib nor std.zlib are a compression library, they merely wrap one. Probably it would be more correct if this was changed to either say that it uses the zlib library or the etc.c.zlib bindings / std.zlib wrapper for the zlib library.
ghost
marked this pull request as ready for review
std/zip.d
Outdated
| unpack algorithm) | ||
| ) | ||
|
|
||
| The current implementation makes use of the etc.c.zlib compression library. |
There was a problem hiding this comment.
Neither etc.c.zlib nor std.zlib are a compression library, they merely wrap one. Probably it would be more correct if this was changed to either say that it uses the zlib library or the etc.c.zlib bindings / std.zlib wrapper for the zlib library.
|
Thanks for your pull request and interest in making D better, @berni44! We are looking forward to reviewing it, and you should be hearing from a maintainer soon.
Please see CONTRIBUTING.md for more information. If you have addressed all reviews or aren't sure how to proceed, don't hesitate to ping us with a simple comment. Bugzilla referencesYour PR doesn't reference any Bugzilla issue. If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog. Testing this PR locallyIf you don't have a local development environment setup, you can use Digger to test this PR: dub fetch digger
dub run digger -- build "master + phobos#7255" |
|
Resolved merge conflict and changed Posix to POSIX. |
The format of the table in the main documentation is not yet perfect, but I could not find anything better. Especially I found no local link version, where the displayed value is different to the anchor value. I used REF1_ALTTEXT for this.
I left out the flags and internalAttributes of ArchiveMember, because I don't know exactly their meaning. As I have to investigate on this anyway, I'll fill this in, when I know better.
I would be happy if a native english speaker could correct any language mistakes I made.