Mercurial > libervia-backend

comparison doc/libervia-cli/event.rst @ 4037:524856bd7b19

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
massive refactoring to switch from camelCase to snake_case: historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a pre-PEP8 code, to use the same coding style as in Twisted. However, snake_case is more readable and it's better to follow PEP8 best practices, so it has been decided to move on full snake_case. Because Libervia has a huge codebase, this ended with a ugly mix of camelCase and snake_case. To fix that, this patch does a big refactoring by renaming every function and method (including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case. This is a massive change, and may result in some bugs.
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 13:54:42 +0200
parents 3c3275a6dc8f
children d6837db456fd
comparison
equal deleted inserted replaced
4036:c4464d7ae97b 4037:524856bd7b19
33 Create a new event. You can specify the starting time of the event with ``-S TIME_PATTERN, --start TIME_PATTERN``, and either its end time with ``-E TIME_PATTERN, --end TIME_PATTERN`` or its duration with ``-D DURATION, --duration DURATION``. ``--start`` and ``--end`` use a full :ref:`time_pattern` when ``--duration`` uses the relative delta part of it. It's mandatory when creating and event to specify starting and ending time (or duration). 33 Create a new event. You can specify the starting time of the event with ``-S TIME_PATTERN, --start TIME_PATTERN``, and either its end time with ``-E TIME_PATTERN, --end TIME_PATTERN`` or its duration with ``-D DURATION, --duration DURATION``. ``--start`` and ``--end`` use a full :ref:`time_pattern` when ``--duration`` uses the relative delta part of it. It's mandatory when creating and event to specify starting and ending time (or duration).
34 34
35 If your organsise an item, the ``--rsvp`` flag should be used: it will use the default 35 If your organsise an item, the ``--rsvp`` flag should be used: it will use the default
36 RSVP form which ask for attendance. If you want to request more information to your guest, 36 RSVP form which ask for attendance. If you want to request more information to your guest,
37 ``--rsvp_json JSON`` can be used: the JSON argument is a data dict as described in 37 ``--rsvp_json JSON`` can be used: the JSON argument is a data dict as described in
38 ``dataDict2dataForm`` function where the ``namespace`` key is not necessary (it's set 38 ``data_dict_2_data_form`` function where the ``namespace`` key is not necessary (it's set
39 automatically): 39 automatically):
40 40
41 .. autofunction:: sat.tools.xml_tools.dataDict2dataForm 41 .. autofunction:: sat.tools.xml_tools.data_dict_2_data_form
42 42
43 If the event links to an other one, ``--external JID NODE ITEM`` can be user 43 If the event links to an other one, ``--external JID NODE ITEM`` can be user
44 44
45 example 45 example
46 ------- 46 -------