You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
On Monday, November 27, 2017, fmv1992 ***@***.***> wrote:
@westurner <https://github.com/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,
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#813 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AADGy4T3ZXJ_Z3jGot9dBZ5peMLKErB6ks5s6rlQgaJpZM4QfdWL>
.
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.
Activity
alphaCTzo7G commentedon Nov 15, 2017
Feel free to add any changes directly to this repo or provide any suggestions..
changed readme.rst to readme.md according to issues #805 and #813
changed readme.rst to readme.md according to issues #805 and #813
fmv1992 commentedon Nov 15, 2017
@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'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.
doing it and I think we should embrace those "official" directives.
Thanks for your help.
alphaCTzo7G commentedon Nov 16, 2017
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
fmv1992 commentedon Nov 18, 2017
@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,
westurner commentedon Nov 25, 2017
Why did you remove the links to the docs for each included component (which I took the time to add)?
Is there a different place for links to these docs where the links are clickable?
westurner commentedon Nov 25, 2017
... https://github.com/alphaCTzo7G/python-mode/blob/cc11bc3073a0ad3b37f36c90caf3ac47397550d6/README.rst#source-links
fmv1992 commentedon Nov 27, 2017
@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,
westurner commentedon Nov 27, 2017
fmv1992 commentedon Nov 27, 2017
@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.mdwould be very useful.Best :)
DOC: readme.md: link to wiki (python-mode#813)
Merge pull request #818 from westurner/patch-2
stale commentedon Apr 26, 2018
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.
stale commentedon May 17, 2018
Closed due to inactivity.