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

No documentation on journals (issue comments) #120

Closed
pfctdayelise opened this Issue Feb 23, 2016 · 4 comments

Comments

3 participants
@pfctdayelise

pfctdayelise commented Feb 23, 2016

Firstly, I just wanted to say this library is a real pleasure to use. So thanks for that.

The only problem I encountered is that it was difficult to figure out how to access the issue comments, I found there is a resource called 'Journal' which is the comments, but it is not well documented like the other resources.

Cheers for making such a nice well-documented lib!

@maxtepkeev maxtepkeev added the docs label Mar 11, 2016

@maxtepkeev maxtepkeev self-assigned this Mar 11, 2016

@maxtepkeev

This comment has been minimized.

Owner

maxtepkeev commented Mar 11, 2016

Agree, thanks for raising this issue. Will do that ASAP.

@Heilage

This comment has been minimized.

Heilage commented Feb 16, 2017

Any progress on these docs? I'm currently trying to add new journals to an issue, but the new() operation doesn't seem to be supported (or I'm doing something wrong).

@maxtepkeev

This comment has been minimized.

Owner

maxtepkeev commented Feb 18, 2017

Yes, I'm preparing for v2.0.0 release which will include updated docs. But basically IssueJournal resource is just a wrapper, it doesn't have any standard methods, e.g. new(), filter() etc. If you want to add new journals just use redmine.issue.update(ISSUE_ID, notes='blah') that's it

@maxtepkeev

This comment has been minimized.

Owner

maxtepkeev commented Mar 12, 2017

This information was added to the new docs that will be available together with v2.0.0 in the end of March.

@maxtepkeev maxtepkeev closed this Mar 12, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment