Skip to content
This repository has been archived by the owner on Jun 24, 2023. It is now read-only.

/dev/api has multiple references to "reddit"/"subreddit" #18

Closed
YhvrWasTaken opened this issue Apr 14, 2019 · 4 comments
Closed

/dev/api has multiple references to "reddit"/"subreddit" #18

YhvrWasTaken opened this issue Apr 14, 2019 · 4 comments

Comments

@YhvrWasTaken
Copy link

If you could point me to where the docs are, I might be able to tidy it up a bit.

@wizzwizz4
Copy link
Contributor

wizzwizz4 commented Apr 14, 2019

/r2/r2/templates/apihelp.html, but there's also a .m file and I'm not sure which is the canonical version. Why are there two copies‽ What's worse, it seems like @libertysoft3 was responsible for this duplication; I'd like an explanation, and then a better way of doing it so I can implement that instead.

I got an explanation; it's for the mobile site… which means that this is actually one of the most sensible ways of doing it. ☹

@libertysoft3
Copy link
Owner

libertysoft3 commented Apr 15, 2019

I cleaned up some of this here: 2df6bf7

Also it looks like a lot of this documentation is strewn around the codebase, like in comments inside method implementations.

Removing all references to 'subreddit' is maybe further than we should go. I think the api should stay reddit compatible, so a parameter named 'subreddit' should not change. Some mentions of 'subreddit' also come directly from class names, etc., and we certainly don't want to start renaming a ton of code just for the sake of renaming.

Also this code should be a reddit open source continuation, so that people can pick it up and feel comfortable having a 'reddit clone' in addition to having a 'saidit' clone.

Removing all mentions of 'reddit' should be a lot less problematic though and should be doable.

@libertysoft3
Copy link
Owner

Alright, so after 4112729 the only "reddit" left on the page is "search_reddit_names". So I think we're good to close for now.

@libertysoft3
Copy link
Owner

Resolved by 4112729

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants