itchyny / calendar.vim

A calendar application for Vim
MIT License
1.95k stars 71 forks source link

Documentation *calendar-view* is misleading #191

Closed SureshGovindachar closed 3 years ago

SureshGovindachar commented 3 years ago

Extract from documentation below contradicts the following quote:

This is an expected behavior. There's no sentence in doc where event view comes after the clock view.

Originally posted by @itchyny in https://github.com/itchyny/calendar.vim/issues/190#issuecomment-752666250

  ------------------------------------------------------------------------------
  VIEW                      *calendar-view*

  This application has some different views. You can switch views with |>| and
  |<| keys. The default views setting is the following.

    1. Year view
    2. Month view
    3. Week view
    4. Days view
    5. Day view
    6. Clock view
    7. Event view

  1. Year view                  *calendar-view-year*
    This view shows the months. If the window is not wide enough to view
    all the months in the year, it shows the nearest 3 or 5 months.
    The name of the year view is 'year'.

  ~
  ~
  ~

  6. Clock view                 *calendar-view-clock*
    This view shows a digital clock.
    The name of the clock view is 'clock'.

  7. Event view                 *calendar-view-event*
    This view shows a event list. There are two available event views:
    'event' and 'agenda'.

  ------------------------------------------------------------------------------
  KEY MAPPINGS                  *calendar-key-mappings*