Pytorch-lightning: We need more detailed comments.

[lartpang]

Is your feature request related to a problem? Please describe.

I'm always frustrated when I do not know the meaning of the parameter. We need more detailed comments, otherwise it is not convenient for developers.

like these code:

https://github.com/williamFalcon/pytorch-lightning/blob/master/pytorch_lightning/models/trainer.py#L86-L115

Describe the solution you'd like

Like PyTorch, every function and every parameter, they all have corresponding comments.

Describe alternatives you've considered

More frequent search in documents. :tired_face:

Additional context

I use the PyCharm, I am used to using ctrl-q to view function documentation... So I think this requirement is very important, and certainly other users have considered similar issues.

[williamFalcon]

@lartpang good suggestion. will document functions inline

[williamFalcon]

@lartpang this was merged a bit ago. Please check to make sure it's what you meant