Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up english #642

Merged
merged 1 commit into from
Oct 28, 2015
Merged

Clean up english #642

merged 1 commit into from
Oct 28, 2015

Conversation

steveno
Copy link
Contributor

@steveno steveno commented Oct 26, 2015

No description provided.

@steveno
Copy link
Contributor Author

steveno commented Oct 26, 2015

This replaces the previous pull request. Sorry about that.

@masatake
Copy link
Member

@vhda, can I ask you to review this?
I'm a really bad person for this task.

@vhda
Copy link
Contributor

vhda commented Oct 27, 2015

@masatake do you have any comments regarding the width of the text? Documentation has been mostly done by you, so I'm not sure if you followed any specific guideline.


Add a prefix 'ex' which will result in 'ctags' transformed into 'exctags'
To add a prefix 'ex' which will result in 'ctags' being transformed into 'exctags'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the "which" would benefit from a preceding comma. Typically, when no comma is used the word "that" is used instead.

@vhda
Copy link
Contributor

vhda commented Oct 27, 2015

@steveno take into account that you can use git push -f to update these commits instead of creating a new Pull Request.

@steveno
Copy link
Contributor Author

steveno commented Oct 27, 2015

@vhda Yeah, I know. I messed up my repo and frankly it was easier to start from scratch. I sort of love git most days, but other days I can understand why OpenBSD still uses CVS.

@vhda
Copy link
Contributor

vhda commented Oct 27, 2015

@steveno if you say that is because you don't know about git reflog. After you know this command it is impossible to mess your repository.
And if you do mess with your repository, then I'm sure you are doing things that are impossible to do in CVS.

@masatake
Copy link
Member

@vhda, what I can say is LGTM. "To add" is obviously better than "Add".

@steveno, do you read whole the documents? I have had only a few feed-backs about the docs/*.rst.
I really want to get comments.

When releasing, we have to move some parts of the documents to ctags.1.in.

@vhda
Copy link
Contributor

vhda commented Oct 27, 2015

Ok. In that case from my part everything is LGTM.
@steveno if you intend to also include the comma change please do tell me, otherwise I will simply merge this PR, as it is not that important :)

masatake added a commit that referenced this pull request Oct 28, 2015
@masatake masatake merged commit 3852c2a into universal-ctags:master Oct 28, 2015
@masatake
Copy link
Member

@steveno, if you really want not to use git and have interests improving document, I will reopen #353 :)

We really need volunteers about this area; I have been written some documents but they may be broken. It prevents releasing.

@masatake
Copy link
Member

Thank you for the contribution.

@steveno
Copy link
Contributor Author

steveno commented Oct 29, 2015

Sorry about the delay! Hectic week!

@masatake I did not read all of the docs. I would be happy to review some specific ones if you want. Just let me know.

@vhda I will have to checkout git reflog

@steveno steveno deleted the patch-1 branch October 29, 2015 15:45
@masatake
Copy link
Member

currently we have two docuemts.

  1. ctags.1: These are for (A) normal user. Stable feature should be written here.
  2. docs/*.rst: These are for (A) people who want to hack ctags, and (B) staging for ctags.1.

One of thing I expect to doc reviewers is comments about which new features we wrote in *.rst can be moved to ctags.1.

I got comments about optlib. Its directory structure is too complex. This kind of comments helps me to know what kind of feature I should work on more.

In other word, I would like to ask people which new feature do you like?
If you have a topic you would like to know, tell me.

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants