Skip to content

Documentation fixups#4827

Merged
pks-t merged 2 commits into
libgit2:masterfrom
tiennou:fix/documentation-fixups
Oct 4, 2018
Merged

Documentation fixups#4827
pks-t merged 2 commits into
libgit2:masterfrom
tiennou:fix/documentation-fixups

Conversation

@tiennou
Copy link
Copy Markdown
Contributor

@tiennou tiennou commented Oct 1, 2018

While looking at the worktree documentation, I managed to listen to a few of the "undocumented" warnings my tweaked docurium raises. So here's a few smallish additions/fixes to documentation comments.

The underlying code uses GIT_CONFIG_FILENAME_GLOBAL, which is .gitconfig.
@tiennou
Copy link
Copy Markdown
Contributor Author

tiennou commented Oct 1, 2018

Note that AFAICS the documentation is still built using "vanilla" docurium, which will likely result in no actual change to what's shown (vs the tweaked version, which now autolinks known types on documented struct members).

@pks-t pks-t merged commit cceefcd into libgit2:master Oct 4, 2018
@pks-t
Copy link
Copy Markdown
Member

pks-t commented Oct 4, 2018

These all look good to me, thanks for working on them. I cannot really help you with your docurium quest, though, as I've neither used it myself nor have I ever done anything with Ruby. :/

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.

2 participants