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.

Sign up for GitHub

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

Jump to bottom

Support LDoc #72

Merged
merged 4 commits into from
Oct 8, 2021
Merged

Support LDoc #72

merged 4 commits into from
Oct 8, 2021

Conversation

ligurio
Copy link
Member

@ligurio ligurio commented Sep 9, 2021 •
edited
Loading

@ligurio ligurio marked this pull request as draft September 9, 2021 15:03
@ligurio ligurio force-pushed the ligurio/ldoc branch 4 times, most recently from 5ff75ac to a73b751 Compare September 13, 2021 13:19
ArtDu
ArtDu reviewed Sep 14, 2021
View reviewed changes
ArtDu
ArtDu reviewed Sep 14, 2021
View reviewed changes
ArtDu
ArtDu reviewed Sep 14, 2021
View reviewed changes
@ligurio ligurio added the documentation Improvements or additions to documentation label Sep 16, 2021
@ligurio ligurio marked this pull request as ready for review September 16, 2021 18:04
@ligurio ligurio force-pushed the ligurio/ldoc branch 6 times, most recently from 6603d79 to 6364424 Compare September 22, 2021 21:04
@ligurio ligurio requested a review from olegrok September 24, 2021 11:31
ArtDu
ArtDu reviewed Sep 24, 2021
View reviewed changes
olegrok
olegrok reviewed Sep 24, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
Totktonada
Totktonada reviewed Sep 26, 2021
View reviewed changes
@ligurio ligurio force-pushed the ligurio/ldoc branch 2 times, most recently from a0b3a4e to ea4e11f Compare September 27, 2021 14:13
@ligurio ligurio self-assigned this Sep 28, 2021
@ligurio ligurio force-pushed the ligurio/ldoc branch 2 times, most recently from 53cdfb0 to 46657b7 Compare October 7, 2021 09:19
ArtDu
ArtDu approved these changes Oct 7, 2021
View reviewed changes
Copy link
Contributor

@ArtDu ArtDu left a comment

Choose a reason for hiding this comment

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

LGTM

@Totktonada
Copy link
Member

I didn't look over all changes again, but I see that my comments was resolved and I unlikely will add more.

The only thing remains in about #14. I think there should be an extra note about the force option (at least until we'll resolve #42). See #72 (comment).

ligurio added 4 commits October 8, 2021 11:04
@ligurio
Update documentation and convert to LDoc format
3eb232b 
expirationd contains documentation in source code and in a README.
In both places descriptions of API methods are incomplete and
looks sloppy. My experience with LDoc shows that it can help to
place documentation as close to the code as it possible
and generate documentation in HTML format that are looks nice
and convenient for reading.

This change moves all descriptions of API methods to comments in a Lua
source code and removes API descriptions in the README. Descriptions of
API functions contains a types of arguments and these types conforms to
types used by checks module for validation functions arguments. I have
discovered two options that expirationd.start() uses but both were not
documented: `options.vinyl_assumed_space_len` and
`options.vinyl_assumed_space_len_factor`.

Closes #60
Part of #14
Part of #79
@ligurio
Support to generate documentation using make
d768f4d 
Closes #79
@ligurio
Update comparison table
6d37843 
Commit "readme: add usage scenarios for expirationd, indexpiration and
moonwalker" (b8db7bf)

Follows up #53
@ligurio
Add note about using expirationd with replication
0558013 
Closes #14
@ligurio ligurio requested a review from Totktonada October 8, 2021 09:52
Totktonada
Totktonada approved these changes Oct 8, 2021
View reviewed changes
Copy link
Member

@Totktonada Totktonada left a comment

Choose a reason for hiding this comment

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

LGTM.

I didn't review it again, but all my past comments were resolved and so I'm okay.

@ligurio ligurio merged commit fbdf996 into master Oct 8, 2021
@ligurio ligurio deleted the ligurio/ldoc branch October 8, 2021 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@olegrok olegrok olegrok left review comments

@Totktonada Totktonada Totktonada approved these changes

@ArtDu ArtDu ArtDu approved these changes

Assignees

@ligurio ligurio

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ligurio @Totktonada @olegrok @ArtDu