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

Better doc strings in haskell-commands.el #642

Closed
geraldus opened this issue May 12, 2015 · 3 comments
Closed

Better doc strings in haskell-commands.el #642

geraldus opened this issue May 12, 2015 · 3 comments

Comments

@geraldus
Copy link
Contributor

haskell-process-restart and haskell-process-start both refer to inferior process, however this functions also used to re/start interactive-mode process. I think we should generalise doc strings somehow because this is a bit confusing:
https://github.com/haskell/haskell-mode/blob/master/haskell-commands.el#L36-L37
https://github.com/haskell/haskell-mode/blob/master/haskell-commands.el#L43-L44
Update: this could be related https://github.com/haskell/haskell-mode/blob/master/haskell-process.el#L82

haskell-process-hayoo-ident doc string looks obsolete:
https://github.com/haskell/haskell-mode/blob/master/haskell-commands.el#L168-L169

Here is some updates already done https://github.com/geraldus/haskell-mode/commit/f216375dbd74731db2879405408d109dbdf088e9

@geraldus geraldus changed the title Better doc strings Better doc strings in haskell-commands.el May 12, 2015
@geraldus
Copy link
Contributor Author

@gracjan please review https://github.com/geraldus/haskell-mode/compare/master...geraldus:better-doc-strings-haskell-commands

There are 3 warnings left, and I have no strong opinion about them, I marked issues with FIXMEs.

@gracjan
Copy link
Contributor

gracjan commented May 12, 2015

I do not seem to be able to comment inline until you create a pull request.

In case of arguments where I do not know to wrtie I usually refer to function that can produce such an argument. For example where you describe SESSION you can refer to haskell-session-make. And that is good enough.

@geraldus
Copy link
Contributor Author

Ok, I'll close it, here is a PR #644. Let's move discussion there.

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

No branches or pull requests

2 participants