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

Update documentation #16

Open
HarelM opened this issue Sep 8, 2017 · 4 comments
Open

Update documentation #16

HarelM opened this issue Sep 8, 2017 · 4 comments
Assignees
Milestone

Comments

@HarelM
Copy link

HarelM commented Sep 8, 2017

Hi,

Can you please update documentation?
The following is incorrect:
var site = await WikiSite.CreateAsync(wikiClient, "https://test2.wikipedia.org/w/api.php");
Should be (I hope)
var site = await Site.CreateAsync(wikiClient, "https://test2.wikipedia.org/w/api.php");

Also would be helpful to provide more example of API usage, for example, I want to use this library to upload images, but I'm not sure how to do it from the documentation.

@CXuesong
Copy link
Owner

CXuesong commented Sep 8, 2017

Ooooops. It's my fault…… There are some renaming involved in v0.6-int pre-releases. Since then I have paused the development process for a while and didn't have enough time to update README to reflect all of these changes. While actually I suggest you to try the latest pre-release, the current example given on README is a a mixture of v0.5 and v0.6. Still, if you continue to use v0.5, here is a documentation for that version.

I begin to realize it's important to update the documentation to reflect the changes on the class names from v0.5 to v0.6-int; thus I will close this issue when the documentation has been properly updated.

@CXuesong CXuesong self-assigned this Sep 8, 2017
@CXuesong CXuesong added this to the v0.6.0 milestone Sep 8, 2017
@HarelM
Copy link
Author

HarelM commented Sep 8, 2017

No Problem, Thanks for the quick response!
I really don't want to write yet another wiki client and other C# libraries seems extremely outdated, do If you don't mind I'll open up issues here to let you know what issues I find when trying to use this client.

@CXuesong
Copy link
Owner

CXuesong commented Sep 8, 2017

Oh, that would be really, really helpful! I will make use of my intermittent time windows to handle these. After all, it's a v0.x library :-P

@CXuesong
Copy link
Owner

CXuesong commented Sep 8, 2017

Updated README in 5c9eaa5. Now it reflects the changes of class names.

@CXuesong CXuesong modified the milestones: v0.6.0, Future Jul 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants