top button
Flag Notify
    Connect to us
      Site Registration

Site Registration

GIT: Best practices on updating documentation?

+2 votes
380 views

If I'm going to be adding an option to a command, should I update the documentation in the same commit or in a separate commit?

posted Oct 13, 2013 by Abhay Kulkarni

Share this question
Facebook Share Button Twitter Share Button LinkedIn Share Button

1 Answer

+1 vote

I would say the same commit, where it can help a reviewer see the code change in the context of the expected user-facing behaviour.

answer Oct 13, 2013 by Meenal Mishra
Similar Questions
0 votes
MongoDB: Missing documentation on authorization and internal authentication in ReplicaSet

I stumbled on a problem transforming a standalone Mongo instance to a replicaset. The standalone already had authorization enabled.When I transformed it to a replicaset and started adding the members, it failed.

Googling around, I found that I needed to setup internal authentication with keyfiles for this. But I cant find in the documentation where it says that this is mandatory.I found that enabling internal authentication also enables authorisation, but not the other way around.

Have I found a missing piece in the documentation or is there a piece in the documentation that I have not found yet?

+4 votes
Python: Doc generation from annotated source code?

I just started rewritting my project from python 2 to python 3. I noticed that there are these new parameter and return value annotations. I have docstrings everywhere in my project, but I plan to convert many of them into annotations. The question is: what kind of auto documenting system should I use for this? Previously I have used Sphinx. Is it okay to use that for python 3 source code? Is there a better alternative?

+2 votes
I have Multiple SKU of my application (eg Standard, Enterprise, Corporate), what is best or suggested git workflow?

I have Multiple SKU of my application (eg Standard, Enterprise, Corporate), what is best or suggested git workflow for it? or I should manage it in separate folders as separate project with individual git standard flow ?

...