Skip to content

Modifications to Readme.rst #813

Closed
Closed

Description

@alphaCTzo7G

I modified the Readme.rst but its not yet ready to be merged. I broke some of it, so will correct them, before doing a PR: https://github.com/alphaCTzo7G/python-mode/blob/develop/README.rst

Main changes

  1. put a high level description of the library
  2. removed names of the libraries
  3. removed links to docs and names of libraries

Some things that need to be modified

  1. put the document and library links back into the wiki and put a link to the wiki here
  2. correct for the broken elements
  3. probably change from pathogen to Vundle
  4. consider moving from .rst to .md, as people are more familiar with .md syntax

Activity

  1. alphaCTzo7G commented on Nov 15, 2017

    @alphaCTzo7G
    ContributorAuthor

    Feel free to add any changes directly to this repo or provide any suggestions..

  2. fmv1992 commented on Nov 15, 2017

    @fmv1992
    Contributor

    @alphaCTzo7G,

    Thanks for the changes. I converted your file to markdown and already updated
    the develop branch.

    Most changes were on formatting issues.

    Notes:

    • I think most of our code in the future will be in vimscript (unfortunately).
      I'm also a huge fan of python but now that we are moving to submodules we
      will have a larger proportion of vimscript to maintain.
    • On the preferred way of installing vim plugins: vim8 has an official way of
      doing it and I think we should embrace those "official" directives.
    • Naturally this file will change a lot during our redesign of the code.

    Thanks for your help.

  3. alphaCTzo7G commented on Nov 16, 2017

    @alphaCTzo7G
    ContributorAuthor

    Looks great!

    Perhaps we can use this ongoing thread for discussions about README, and discuss about the structure of python-mode going forward in the other thread.

    Agree. We probably have to change this as we go along.

    I was thinking we can probably include something like this gif on the youcompleteme:https://camo.githubusercontent.com/1f3f922431d5363224b20e99467ff28b04e810e2/687474703a2f2f692e696d6775722e636f6d2f304f50346f6f642e676966

    I notice this in a lot of language related plugins:

    https://github.com/w0rp/ale

    https://github.com/Valloric/YouCompleteMe

    https://github.com/lifepillar/vim-mucomplete

    https://github.com/Shougo/deoplete.nvim

    It may quickly conveyed the potential for this plugin, espeically among a lot of noise in the vim plugin space. What do you think?

    These are some things I will continue working on

    • move links to wiki and collect other documentation about pymode
    • test with Vundle/Vim8.0 plugin manager and put instructions
    • correct typos
  4. fmv1992 commented on Nov 18, 2017

    @fmv1992
    Contributor

    @alphaCTzo7G,

    Agreed lets use this thread for README.md discussions.

    It would be great to have one of those gifs in our plugin. I'm not sure which
    functionalities should be highlighted though.

    And I also think that these 3 points are worthy too.

    Best,

  5. westurner commented on Nov 25, 2017

    @westurner
    Contributor

    Why did you remove the links to the docs for each included component (which I took the time to add)?

    1. removed names of the libraries
    2. removed links to docs and names of libraries

    Is there a different place for links to these docs where the links are clickable?

  6. fmv1992 commented on Nov 27, 2017

    @fmv1992
    Contributor

    @westurner,

    We tidied up our readme file and we decided not to use rst anymore.

    I'm sorry that we have removed those links thus throwing away some of your
    work. They might have been lost during the conversion process.

    Nothing against the links, they can be included again. If you do it please put
    them on an appropriate section/layout.

    A new guideline for the readme file is to keep it lean. We will probably create
    a wiki where exhaustive information can be displayed.

    Best,

  7. westurner commented on Nov 27, 2017

    @westurner
    Contributor
  8. fmv1992 commented on Nov 27, 2017

    @fmv1992
    Contributor

    @westurner,

    Thanks for asking. We believe we are increasing the possibilities of
    collabortaion by using markdown. So if you could please use markdown.

    And yes a link to readme.md would be very useful.

    Best :)

  9. added a commit that references this issue on Dec 1, 2017
  10. stale commented on Apr 26, 2018

    @stale

    This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

  11. stale commented on May 17, 2018

    @stale

    Closed due to inactivity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions