Skip to content

Commit

Permalink
Merge pull request jReddit#58 from sfat/master
Browse files Browse the repository at this point in the history
Small improvements
  • Loading branch information
Karan Goel committed May 12, 2014
2 parents ea27cb5 + d69e426 commit 78e61f4
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 22 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jReddit is a wrapper for the Reddit API written in Java. Project started by Omer
jReddit can login with a user, retrieve user information, submit new links, and vote/comment on submissions, send and receive messages and notifications among other things.

### What's next for jReddit?
The plan is to implement every feature documented [here](http://www.reddit.com/dev/api). To see which methods have been implemented, and which have not, see [this file](https://github.com/karan/jReddit/blob/karan/implemented_methods.md).
The plan is to implement every feature documented [here](http://www.reddit.com/dev/api). To see which methods have been implemented, and which have not, see [this file](https://github.com/karan/jReddit/blob/master/implemented_methods.md).

### How to contribute?
Personally, I would suggest reading through the source code to understand the general structure and standards used. Then check the [implemented_methods.md](https://github.com/karan/jReddit/blob/karan/implemented_methods.md) file to see which methods have not yet been implemented. Choose the ones you'd like to contribute to. After you write the method (and maybe commit it?), write a test to see if it works fine and as expected. Then make sure other tests are working too and your code does not break anty other method.
Personally, I would suggest reading through the source code to understand the general structure and standards used. Then check the [implemented_methods.md](https://github.com/karan/jReddit/blob/master/implemented_methods.md) file to see which methods have not yet been implemented. Choose the ones you'd like to contribute to. After you write the method (and maybe commit it?), write a test to see if it works fine and as expected. Then make sure other tests are working too and your code does not break anty other method.

Send in a pull request with the test and I'll be happy to merge! :-)

Expand Down
20 changes: 0 additions & 20 deletions src/main/java/com/github/jreddit/subreddit/Subreddit.java
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ public Subreddit(String displayName, String name, String title, String url,
* Sets the timestamp of when the subreddit was created.
*
* @param created Timestamp of when the subreddit was created.
* @author Benjamin Jakobus
*/
public void setCreated(String created) {
this.created = created;
Expand All @@ -103,7 +102,6 @@ public void setCreated(String created) {
* Sets the UTC timestamp of when the subreddit was created.
*
* @param createdUTC UTC timestamp of when the subreddit was created.
* @author Benjamin Jakobus
*/
public void setCreatedUTC(String createdUTC) {
this.createdUTC = createdUTC;
Expand All @@ -113,7 +111,6 @@ public void setCreatedUTC(String createdUTC) {
* Sets the description detailing the subreddit
*
* @param description Description detailing the subreddit.
* @author Benjamin Jakobus
*/
public void setDescription(String description) {
this.description = description;
Expand All @@ -123,7 +120,6 @@ public void setDescription(String description) {
* Sets the subreddit's display name.
*
* @param displayName The subreddit's display name.
* @author Benjamin Jakobus
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
Expand All @@ -133,7 +129,6 @@ public void setDisplayName(String displayName) {
* Sets the subreddit's unique identifier.
*
* @param id The subreddit's unique identifier.
* @author Benjamin Jakobus
*/
public void setId(String id) {
this.id = id;
Expand All @@ -143,7 +138,6 @@ public void setId(String id) {
* Sets the subreddit's actual name (not its display name).
*
* @param name The subreddit's actual name.
* @author Benjamin Jakobus
*/
public void setName(String name) {
this.name = name;
Expand All @@ -153,7 +147,6 @@ public void setName(String name) {
* Sets the flag of whether or not the subreddit is for over 18's.
*
* @param nsfw True if the subreddit is for over 18's; false if not.
* @author Benjamin Jakobus
*/
public void setNsfw(boolean nsfw) {
this.nsfw = nsfw;
Expand All @@ -163,7 +156,6 @@ public void setNsfw(boolean nsfw) {
* Sets the number of subscribers for this subreddit.
*
* @param subscribers The number of subscribers for this subreddit.
* @author Benjamin Jakobus
*/
public void setSubscribers(int subscribers) {
this.subscribers = subscribers;
Expand All @@ -173,7 +165,6 @@ public void setSubscribers(int subscribers) {
* Sets the subreddit's title.
*
* @param title The subreddit's title.
* @author Benjamin Jakobus
*/
public void setTitle(String title) {
this.title = title;
Expand All @@ -183,7 +174,6 @@ public void setTitle(String title) {
* Sets the subreddit's URL.
*
* @param url The subreddit's URL.
* @author Benjamin Jakobus
*/
public void setUrl(String url) {
this.url = url;
Expand All @@ -193,7 +183,6 @@ public void setUrl(String url) {
* Returns the timestamp of when the subreddit was created.
*
* @return Timestamp of when the subreddit was created.
* @author Benjamin Jakobus
*/
public String getCreated() {
return created;
Expand All @@ -203,7 +192,6 @@ public String getCreated() {
* Returns the UTC timestamp of when the subreddit was created.
*
* @return UTC timestamp of when the subreddit was created.
* @author Benjamin Jakobus
*/
public String getCreatedUTC() {
return createdUTC;
Expand All @@ -213,7 +201,6 @@ public String getCreatedUTC() {
* Returns the description detailing the subreddit
*
* @return Description detailing the subreddit.
* @author Benjamin Jakobus
*/
public String getDescription() {
return description;
Expand All @@ -223,7 +210,6 @@ public String getDescription() {
* Returns the subreddit's display name.
*
* @return The subreddit's display name.
* @author Benjamin Jakobus
*/
public String getDisplayName() {
return displayName;
Expand All @@ -233,7 +219,6 @@ public String getDisplayName() {
* Returns the subreddit's unique identifier.
*
* @return The subreddit's unique identifier.
* @author Benjamin Jakobus
*/
public String getId() {
return id;
Expand All @@ -243,7 +228,6 @@ public String getId() {
* Returns the subreddit's actual name (not its display name).
*
* @return The subreddit's actual name.
* @author Benjamin Jakobus
*/
public String getName() {
return name;
Expand All @@ -253,7 +237,6 @@ public String getName() {
* Returns the number of subscribers for this subreddit.
*
* @return The number of subscribers for this subreddit.
* @author Benjamin Jakobus
*/
public int getSubscribers() {
return subscribers;
Expand All @@ -263,7 +246,6 @@ public int getSubscribers() {
* Returns the subreddit's title.
*
* @return The subreddit's title.
* @author Benjamin Jakobus
*/
public String getTitle() {
return title;
Expand All @@ -273,7 +255,6 @@ public String getTitle() {
* Returns the subreddit's URL.
*
* @return The subreddit's URL.
* @author Benjamin Jakobus
*/
public String getUrl() {
return url;
Expand All @@ -283,7 +264,6 @@ public String getUrl() {
* Returns the flag of whether or not the subreddit is for over 18's.
*
* @return True if the subreddit is for over 18's; false if not.
* @author Benjamin Jakobus
*/
public boolean isNSFW() {
return nsfw;
Expand Down

0 comments on commit 78e61f4

Please sign in to comment.