Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Unclear options #60

Closed
ArtDu opened this issue Jul 1, 2021 · 0 comments
Closed

Unclear options #60

ArtDu opened this issue Jul 1, 2021 · 0 comments
Assignees
@ArtDu
Labels
documentation Improvements or additions to documentation

Comments

@ArtDu
Copy link
Contributor

ArtDu commented Jul 1, 2021 •
edited by ligurio
Loading

  • on_full_scan_success - Function to call after successfully completing a full scan iteration.
  • on_full_scan_error - Function to call after terminating a full scan due to an error.
  • args - Passed to is_tuple_expired and process_expired_tuple() as additional context.
  • full_scan_time - Time required for a full index scan (in seconds).

This option is unclear -- does it allow to stop scanning after the specified period of time?

#52 (comment)
@ArtDu ArtDu mentioned this issue Jul 1, 2021
Merged
@ligurio ligurio added the documentation Improvements or additions to documentation label Sep 10, 2021
ligurio added a commit that referenced this issue Sep 10, 2021
@ligurio
Update documentation and convert to LDoc format
4bf7bab 
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
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 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
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 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
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 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
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
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 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 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
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 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
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 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 ligurio closed this as completed in b8d170b Oct 8, 2021
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
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees

@ArtDu ArtDu

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

No branches or pull requests
2 participants
@ligurio @ArtDu