Updated docstrings

This commit is contained in:
Manuel Cortez 2016-06-29 13:15:40 -05:00
parent ed49bcca00
commit 70a3f2fff3

View File

@ -8,6 +8,7 @@ _(u"""Socializer is an application to use [VK.com](https://vk.com) in an easy an
_(u""""""),
_(u"""* Basic post creation in your wall (including photos)."""),
_(u"""* Audio addition, removal, download and search."""),
_(u"""* audio albums management (create, delete and add audios)."""),
_(u"""* Post comments."""),
_(u"""* like, unlike and repost other's posts."""),
_(u"""* Open other's timelines so you could track someone's friends, posts or audio files."""),
@ -28,6 +29,7 @@ _(u""""""),
_(u"""* A tree view at the left of the window, where you will see the list of buffers. These buffers are divided in three categories, posts, music and people. You could expand each category for seeing the child buffers. There are some additional buffers, timelines and chats, wich will be filled with timelines for your friends or with chats, when you start or receive a chat session."""),
_(u"""* A button for making a post to your wall."""),
_(u"""* In audio buffers, Two buttons: Play and play all."""),
_(u"""* In audio album buffers, a button for loading music. By default, albums are empty, you have to press the load button for getting the album's items."""),
_(u"""* A list where you will see the posts for the currently selected buffer."""),
_(u"""* In people buffers, like the friends buffer, a button for sending a message to your friends. Pressing that button will cause a chat buffer to be created."""),
_(u"""* A status bar where the program will put some useful information about what it's doing at the moment."""),
@ -54,6 +56,8 @@ _(u"""If you open a regular post in your newsfeed, you will be able to see the c
_(u""""""),
_(u"""For friend notifications, you can only view the new added friends in a list and there are some kind of posts that aren't handled. It should be improved."""),
_(u""""""),
_(u"""Additionally, you can press the menu Key or the right click for displaying a menu with some quick actions available for the post you are focusing. These actions are different for every post type."""),
_(u""""""),
_(u"""### Working with songs"""),
_(u""""""),
_(u"""Note: the following applies to audio timelines too."""),
@ -72,22 +76,25 @@ _(u"""When the download starts, you can close the details dialogue and check the
_(u""""""),
_(u"""Additionally, you can search for audios by using the menu bar, in the buffer menu, select search, then audio. It will display a dialog where you have to set your search preferences."""),
_(u""""""),
_(u"""If you press the menu key, you will see a menu where you will be able to do some actions, for example, add the audio to an album, or add/remove the song from your library."""),
_(u""""""),
_(u"""## menu Bar"""),
_(u""""""),
_(u"""You can go to the menu bar by pressing ALT. Right now, there are three menus, application, buffer and help:"""),
_(u""""""),
_(u"""### Application menu"""),
_(u""""""),
_(u""""""),
_(u"""* At the moment, you can set your preferences by opening the preferences dialog located in this menu."""),
_(u"""* Create. Here you can create some things in VK. The only supported item at this moment is the audio album."""),
_(u"""* Delete: Removes items from the VK servers. The only supported item here is the audio album."""),
_(u"""* you can set your preferences by opening the preferences dialog located in this menu."""),
_(u""""""),
_(u"""### Buffer menu"""),
_(u""""""),
_(u"""* search: This submenu allows you to create a new buffer, at the moment, you can create only a kind of buffer, an audio search. The audio search will be located in the music category and will have the last 299 results of your query. It isn't possible to delete the buffers until you restart the client."""),
_(u"""* new timeline: This option allows you to create a new timeline. This kind of buffers is capable of download all posts in an user's profile."""),
_(u"""* search: This submenu allows you to create a new buffer, at the moment, you can create only a kind of buffer, an audio search. The audio search will be located in the music category and will have the last 299 results of your query."""),
_(u"""* Update current buffer: perform an update operation in the selected buffer, which will retrieve the new items."""),
_(u"""* Load previous items: Get the previous items for the currently focused buffer."""),
_(u"""* Remove buffer: Tries to remove the current buffer. It only works with audio searches, because the default buffers shouldn't be removed."""),
_(u"""* Remove buffer: Tries to remove the current buffer. Default buffers can't be removed."""),
_(u""""""),
_(u"""The help menu is self explanatory."""),
_(u""""""),