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

Data Aggregation Documentation #109

Open
Sean12697 opened this issue Oct 5, 2021 · 1 comment
Open

Data Aggregation Documentation #109

Sean12697 opened this issue Oct 5, 2021 · 1 comment
Assignees
Labels
Type: Documentation Improvements or additions to documentation

Comments

@Sean12697
Copy link
Member

In-line code comments should be added to the following classes to define the properties, after that, a reference should be made in the README.md file on how data is aggregated and the purposes behind it.

constructor(name, link, location, desc, startTimeISO, endTimeISO, going, capacity, free, cost, groupName, groupLink, source, ad) {
this.name = name;
this.link = link;
this.location = location;
this.desc = desc;
this.startTimeISO = startTimeISO;
this.endTimeISO = endTimeISO;
this.going = going;
this.capacity = capacity;
this.free = free;
this.cost = cost;
this.groupName = groupName;
this.groupLink = groupLink;
this.source = source;
this.ad = ad;
}

constructor(id, name, desc, link, img, members, sinceLast, untilNext, source, ad) {
this.id = id;
this.name = name;
this.desc = desc.replace(/(<([^>]+)>)/ig, "");
this.link = link;
this.links = [{ link, type: source }];
this.img = img;
this.members = members;
this.sinceLast = sinceLast;
this.untilNext = untilNext;
this.source = source;
this.ad = ad;
}

@Sean12697 Sean12697 added the Type: Documentation Improvements or additions to documentation label Oct 5, 2021
@Sean12697 Sean12697 self-assigned this Oct 5, 2021
@prototype99
Copy link
Contributor

related discussion: #108 (comment)

@Sean12697 Sean12697 mentioned this issue Oct 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants