chore(doc): use correct syntax to generate links

vareversat · Jul 18, 2024 · e0308ec · e0308ec
1 parent b9b8ca7
commit e0308ec
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 9 deletions.
diff --git a/components/alarm_calendar_component.go b/components/alarm_calendar_component.go
@@ -24,7 +24,8 @@ type alarmCalendarComponent struct {
 }
 
 // NewAlarmCalendarComponent create a VALARM calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.6
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.6
 func NewAlarmCalendarComponent(
 	action properties.ActionProperty,
 	trigger properties.TriggerProperty,

diff --git a/components/event_calendar_component.go b/components/event_calendar_component.go
@@ -25,7 +25,8 @@ type eventCalendarComponent struct {
 }
 
 // NewEventCalendarComponent create a VEVENT calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.1
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.1
 func NewEventCalendarComponent(
 	uid properties.UidProperty,
 	dateTimeStamp properties.DateTimeStampProperty,

diff --git a/components/freebusy_calendar_component.go b/components/freebusy_calendar_component.go
@@ -24,7 +24,8 @@ type freeBusyCalendarComponent struct {
 }
 
 // NewFreeBusyCalendarComponent create a VFREEBUSY calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.4
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.4
 func NewFreeBusyCalendarComponent(
 	uid properties.UidProperty,
 	dateTimeStamp properties.DateTimeStampProperty,

diff --git a/components/journal_calendar_component.go b/components/journal_calendar_component.go
@@ -24,7 +24,8 @@ type journalCalendarComponent struct {
 }
 
 // NewJournalCalendarComponent create a VJOURNAL calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.3
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.3
 func NewJournalCalendarComponent(
 	uid properties.UidProperty,
 	dateTimeStamp properties.DateTimeStampProperty,

diff --git a/components/time_zone_calendar_component.go b/components/time_zone_calendar_component.go
@@ -51,7 +51,8 @@ type timeZoneCalendarSubComponent struct {
 }
 
 // NewTimeZoneCalendarComponent create a VTIMEZONE calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
 func NewTimeZoneCalendarComponent(
 	timeZoneId properties.TimeZoneIdProperty,
 	components TimeZoneCalendarSubComponents,
@@ -88,7 +89,8 @@ func (tC *timeZoneCalendarSubComponent) GetProperty(
 }
 
 // NewTimeZoneDayLightSubcomponent create a STANDARD subcomponent of a VTIMEZONE calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
 func NewTimeZoneDayLightSubcomponent(
 	dateTimeStart properties.DateTimeStartProperty,
 	timeZoneOffsetTo properties.TimeZoneOffsetToProperty,
@@ -111,7 +113,8 @@ func NewTimeZoneDayLightSubcomponent(
 }
 
 // NewTimeZoneCalendarStandardSubcomponent create a DAYLIGHT subcomponent of a VTIMEZONE calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.5
 func NewTimeZoneCalendarStandardSubcomponent(
 	dateTimeStart properties.DateTimeStartProperty,
 	timeZoneOffsetTo properties.TimeZoneOffsetToProperty,

diff --git a/components/todo_calendar_component.go b/components/todo_calendar_component.go
@@ -25,7 +25,8 @@ type toDoCalendarComponent struct {
 }
 
 // NewToDoCalendarComponent create a VTODO calendar component
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.2
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.6.2
 func NewToDoCalendarComponent(
 	uid properties.UidProperty,
 	dateTimeStamp properties.DateTimeStampProperty,

diff --git a/properties/attachment_property.go b/properties/attachment_property.go
@@ -13,7 +13,8 @@ type AttachmentProperty interface {
 
 // NewAttachmentProperty create a new ATTACH property
 // This property CAN be seen in VALARM, VEVENT, VTODO & VJOURNAL components
-// [See RFC-5545 ref]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.1
+// See the [RFC-5545] ref for more info
+// [RFC-5545]: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.1.1
 func NewAttachmentProperty(
 	value string,
 	params ...parameters.Parameter,