8000 Update documentation and convert to LDoc · Issue #79 · tarantool/expirationd · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update documentation and convert to LDoc #79

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
Closed
ligurio opened this issue Sep 13, 2021 · 0 comments
Closed

Update documentation and convert to LDoc #79

ligurio opened this issue Sep 13, 2021 · 0 comments
Assignees
@ligurio

Comments

@ligurio
Copy link
Member
ligurio commented Sep 13, 2021
  • track documentation in a single place
  • update documentation for each API method
  • convert to LDoc
  • make doc clear for users
@ligurio ligurio self-assigned this Sep 13, 2021
ligurio added a commit that referenced this issue Sep 13, 2021
@ligurio
Update documentation and convert to LDoc format
6e569b0 
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`.

TODO:
- Task API
- возвращаемые значения
- не описаны поля task (worker_canceled, atomic_iteration)

Closes #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 13, 2021
@ligurio
Support to generate documentation using make
a73b751 
Closes #79
@ligurio ligurio changed the title rework documentation Update documentation and convert to LDoc Sep 13, 2021
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Update documentation and convert to LDoc format
2713649 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Support to generate documentation using make
e58043b 
Closes #79
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Update documentation and convert to LDoc format
163ae35 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 16, 2021
@ligurio
Support to generate documentation using make
8570ca5 
Closes #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Update documentation and convert to LDoc format
26f1401 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Support to generate documentation using make
d4e7626 
Closes #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Update documentation and convert to LDoc format
4ddaf23 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 17, 2021
@ligurio
Support to generate documentation using make
371d59f 
Closes #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
7fb12d1 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Support to generate documentation using make
f0418c4 
Closes #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
a8b23bf 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Support to generate documentation using make
9465520 
Closes #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Update documentation and convert to LDoc format
3ee2377 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 22, 2021
@ligurio
Support to generate documentation using make
60f6880 
Closes #79
@ligurio ligurio mentioned this issue Sep 24, 2021
Merged
ligurio added a commit that referenced this issue Sep 24, 2021
@ligurio
Update documentation and convert to LDoc format
acd7718 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 24, 2021
@ligurio
Support to generate documentation using make
9664d4b 
Closes #79
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Update documentation and convert to LDoc format
136de8b 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Support to generate documentation using make
bf01ad2 
Closes #79
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Update documentation and convert to LDoc format
ae702c9 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Sep 27, 2021
@ligurio
Support to generate documentation using make
b3f53ef 
Closes #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Update documentation and convert to LDoc format
6908f00 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Support to generate documentation using make
eb57325 
Closes #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Update documentation and convert to LDoc format
88d3def 
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 #14
Closes #60
Part of #79
ligurio added a commit that referenced this issue Oct 7, 2021
@ligurio
Support to generate documentation using make
aa569de 
Closes #79
ligurio added a commit that referenced this issue Oct 8, 2021
@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 added a commit that referenced this issue Oct 8, 2021
@ligurio
Support to generate documentation using make
d768f4d 
Closes #79
ligurio added a commit that referenced this issue Oct 8, 2021
@ligurio
Update documentation and convert to LDoc format
b8d170b 
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 ligurio closed this as completed in 8a53833 Oct 8, 2021
ligurio added a commit that referenced this issue Oct 21, 2021
@ligurio
make: add new target that install lua dependencies
fa69d90 
Follows up #79
ligurio added a commit that referenced this issue Oct 21, 2021
@ligurio
make: add new target that install lua dependencies
f950d8a 
Follows up #79
ligurio added a commit that referenced this issue Oct 21, 2021
@ligurio
make: add new target that install lua dependencies
6ffcbc3 
It is rather simple to control all Lua dependencies in a single place.
Well, two places. All runtime dependencies described in LuaRock spec and
all Lua modules required for development described in Makefile. That's
it. Now 'make deps' installs everything that need.

Follows up #79
ligurio added a commit that referenced this issue Oct 21, 2021
@ligurio
ci: publish API documentation
71c7a43 
Follows up #79
@ligurio ligurio mentioned this issue Oct 21, 2021
Merged
ligurio added a commit that referenced this issue Oct 24, 2021
@ligurio
make: add new target that install lua dependencies
9300a98 
It is rather simple to control all Lua dependencies in a single place.
Well, two places. All runtime dependencies described in LuaRock spec and
all Lua modules required for development described in Makefile. That's
it. Now 'make deps' installs everything that need.

Follows up #79
ligurio added a commit that referenced this issue Oct 24, 2021
@ligurio
ci: publish API documentation
b3d544f 
Follows up #79
ligurio added a commit that referenced this issue Oct 26, 2021
@ligurio
ci: publish API documentation
a898e7e 
Follows up #79
ligurio added a commit that referenced this issue Oct 26, 2021
@ligurio
ci: publish API documentation
d132107 
Follows up #79
ligurio added a commit that referenced this issue Oct 29, 2021
@ligurio
ci: publish API documentation
e73471f 
Follows up #79
ligurio added a commit that referenced this issue Oct 30, 2021
@ligurio
make: add new target that install lua dependencies
0118c19 
It is rather simple to control all Lua dependencies in a single place.
Well, two places. All runtime dependencies described in LuaRock spec and
all Lua modules required for development described in Makefile. That's
it. Now 'make deps' installs everything that need.

Follows up #79
ligurio added a commit that referenced this issue Oct 30, 2021
@ligurio
ci: publish API documentation
513fe16 
Follows up #79
ligurio added a commit that referenced this issue Oct 30, 2021
@ligurio
ci: publish API documentation
dee9221 
Follows up #79
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
Update documentation and convert to LDoc format
718baa4 
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 tarantool#60
Part of tarantool#14
Part of tarantool#79
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
Support to generate documentation using make
477b205 
Closes tarantool#79
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
make: add new target that install lua dependencies
935bd76 
It is rather simple to control all Lua dependencies in a single place.
Well, two places. All runtime dependencies described in LuaRock spec and
all Lua modules required for development described in Makefile. That's
it. Now 'make deps' installs everything that need.

Follows up tarantool#79
ArtDu pushed a commit to ArtDu/expirationd that referenced this issue May 10, 2022
@ligurio @ArtDu
ci: publish API documentation
bcf4a62 
Follows up tarantool#79
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ligurio ligurio

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Totktonada @ligurio
2A6F
0