Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Improve update-info-status #1110

Closed
1 of 6 tasks
markus2330 opened this issue Nov 17, 2016 · 4 comments
Closed
1 of 6 tasks

Improve update-info-status #1110

markus2330 opened this issue Nov 17, 2016 · 4 comments

Comments

@markus2330
Copy link
Contributor

markus2330 commented Nov 17, 2016

  • nodoc: With 40 vs. 41 lines it seems a bit arbitrary. In this case maybe something like <30 add nodoc >80 remove nodoc.
    For example base64 could be considered as documented (34 lines, @petermax2 what do you think?), but desktop is rather poorly documented (48 lines, many of them empty, empty lines might be be useful to consider, too).
    src/plugins/uname/README.md is also a corner case: what it does is trivial (32 lines)
  • unittest: should also have some metric, at least the tests as copied from template should not lead to unittest
  • plugins doc and template should not be touched
  • resolver should have nodep. It has LINK_LIBRARIES, but only of pthreads, which is part of libc.

Issues we can live with:

  • configurable: keytometa gets configurable removed wrongly (configuration via. metadata)
  • timeofday and tracer get configure added wrongly (they use elektraPluginGetConfig, but only for /module, which is not really configuration).
markus2330 pushed a commit that referenced this issue Nov 17, 2016
see  #1110 for manually fixed issues
@petermax2
Copy link
Member

Everything base64 does is documented in README.md essentially. I think in-code documentation and comments are important as well.

@petermax2
Copy link
Member

desktop's documentation does not really tell me what desktop is supposed to do:

The plugin is informational and mainly be used to provide context for
other configuration. See elektrify-getenv.

@markus2330
Copy link
Contributor Author

desktop's documentation does not really tell me what desktop is supposed to do

That was my point ;)

markus2330 pushed a commit that referenced this issue Nov 18, 2016
@markus2330
Copy link
Contributor Author

These problems seem to be resolved now. #666 is about adding new infos/status.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants