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

Document Properties with Text from RFC 5545 #742

Open
11 of 19 tasks
niccokunzmann opened this issue Nov 10, 2024 · 2 comments
Open
11 of 19 tasks

Document Properties with Text from RFC 5545 #742

niccokunzmann opened this issue Nov 10, 2024 · 2 comments
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/ help wanted

Comments

@niccokunzmann
Copy link
Member

niccokunzmann commented Nov 10, 2024

The RFC 5545 describes all the properties we have in icalendar.prop.

Please add a __doc__ string documentation for all of them.

Examples:

class vGeo:
    """Geographic Position

    Property Name:  GEO

    Purpose:  This property specifies information related to the global
        position for the activity specified by a calendar component.

    Value Type:  FLOAT.  The value MUST be two SEMICOLON-separated FLOAT
        values.

    Property Parameters:  IANA and non-standard property parameters can
        be specified on this property.

    Conformance:  This property can be specified in "VEVENT" or "VTODO"
        calendar components.

    Description:  This property value specifies latitude and longitude,
        in that order (i.e., "LAT LON" ordering).  The longitude
        represents the location east or west of the prime meridian as a
        positive or negative real number, respectively.  The longitude and
        latitude values MAY be specified up to six decimal places, which
        will allow for accuracy to within one meter of geographical
        position.  Receiving applications MUST accept values of this
        precision and MAY truncate values of greater precision.

    Example:
        GEO:37.386013;-122.082932

        >>> geo = vGeo.from_ical('37.386013;-122.082932')
        >>> geo.latitude
        37.386013
        >>> geo.longitude
        -122.082932
    """

This includes:

  • heading
  • description that gives a rough overview
  • example from the RFC
  • example code for icalendar

Please add one of these in a PR:

  • vBinary
  • vBoolean
  • vCalAddress
  • vDate
  • vDatetime
  • vDuration
  • vFloat
  • vFrequency
  • vGeo
  • vInt
  • vPeriod
  • vRecur
  • vText
  • vTime
  • vUTCOffset
  • vUri
  • vWeekday

The following ones are special because they consist of different properties. Here, we just need a few examples of how to parse with them in from_ical() and examples of how to create them and make ics strings in to_ical()

  • vDDDLists - this is a list of datetime/date values
  • vDDDTypes - this is any of the time values - a nice way to just parse if you do not know what you are having as a value

See also:

@niccokunzmann niccokunzmann added doc help wanted good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/ labels Nov 10, 2024
@SerifOZ
Copy link
Contributor

SerifOZ commented Nov 14, 2024

Can I work this issue?

@niccokunzmann
Copy link
Member Author

niccokunzmann commented Nov 15, 2024 via email

This was referenced Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc good first issue hacktoberfest Issues for participation in the hacktoberfest https://hacktoberfest.com/ help wanted
Projects
None yet
Development

No branches or pull requests

2 participants