Skip to content

Commit

Permalink
more docs and todos
Browse files Browse the repository at this point in the history
  • Loading branch information
eritbh committed Sep 25, 2023
1 parent 35de53a commit e80cb3e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/classes/SubredditConfig.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ import {RawSubredditConfig, RawUsernoteType} from '../types/RawSubredditConfig';
// type imports for doc references
import type {Usernote} from '../types/Usernote';

/** */
/**
* A class that interfaces with the raw contents of a subreddit's `toolbox`
* wiki page, automatically handling schema checks and providing methods to read
* and modify subreddit configuration.
*/
export class SubredditConfig {
private data: RawSubredditConfig;

Expand All @@ -17,6 +21,7 @@ export class SubredditConfig {

/** Returns all usernote types. */
getAllNoteTypes (): RawUsernoteType[] {
// TODO: handle getFrom subreddits
// If the config doesn't specify any note types, make a copy of the
// default set and add them to the config so the unambiguous form will
// be written back
Expand Down

0 comments on commit e80cb3e

Please sign in to comment.