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.

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

Broken example on Dlang wiki. #10

Open
loops opened this issue Nov 3, 2016 · 2 comments
Open

Broken example on Dlang wiki. #10

loops opened this issue Nov 3, 2016 · 2 comments

Comments

@loops
Copy link

loops commented Nov 3, 2016

The example on the getting started page of the D wiki

https://wiki.dlang.org/Getting_Started

includes a broken example that references older code from this repo
that used to include "conv.d".

I spent 10 minutes trying to understand the API required after that
module was dropped and confess complete failure. I'm sure it's
simple, but I don't see any documentation or simple test programs.

Perhaps you could change the Dlang Wiki at least so that the first
exposure to D isn't brokenness :-) Or if you just respond with a little
example program here, i'll happily update the wiki.

Cheers.

@TurkeyMan
Copy link
Owner

I had no idea that example existed. I can fix that... but apart from that, can you tell me what was troubling about the API that lead to failure? This is important feedback.
I agree, documentation would be good (working on it), but I'd also like to think it should be self evident sans-documentation.

@loops
Copy link
Author

loops commented Nov 3, 2016

Heh, well the sum total of my exposure to D is under two hours, so I wouldn't read too much into me not being able to sort out the API. But what would have really helped was a working example similar to the broken one on that wiki. Just to see the proper syntax and basic idea so that I could cargo-cult it as a starting point.

I did look at the unit tests inside your repo here to see if i could find a simple example, and didn't see anything after casting around for a bit. They all seemed to be complicated or be using the private ...Impl. I also read through your Git log and saw where conv.d was deleted, but couldn't make out from the log entry how that affected the API. So I was really casting about in the dark trying to alter the broken wiki example, with no knowledge of D and nothing but guesses about what the API for the color module might be. I didn't stick at it for very long before leaving a note here ;-)

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

No branches or pull requests

2 participants