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.

Sign up for GitHub

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

docs(ICalEvent): Fix JSDoc #554

Merged
merged 2 commits into from
Jan 6, 2024
Merged

docs(ICalEvent): Fix JSDoc #554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6429800
docs(ICalEvent): Fix JSDoc
xehpuk Jan 6, 2024
3784be9
docs(ICalEvent): Fix JSDoc
xehpuk Jan 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/event.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ interface ICalEventInternalRepeatingData {


/**
* Usually you get an `ICalCalendar` object like this:
* Usually you get an `ICalEvent` object like this:
* ```javascript
* import ical from 'ical-generator';
* const calendar = ical();
Expand Down Expand Up @@ -986,15 +986,15 @@ export default class ICalEvent {


/**
* Creates a new [[`ICalCategory`]] and returns it. Use options to prefill the categories' attributes.
* Creates a new [[`ICalCategory`]] and returns it. Use options to prefill the category's attributes.
* Calling this method without options will create an empty category.
*
* ```javascript
* const cal = ical();
* const event = cal.createEvent();
* const category = event.createCategory({name: 'APPOINTMENT'});
*
* // add another alarm
* // add another category
* event.createCategory({
* name: 'MEETING'
* });
Expand Down