#232: Outdated documentation tracking ticket
-----------------------+----------------------------------------------------
Reporter: kparal | Owner:
Type: task | Status: new
Priority: major | Milestone:
Component: docs/wiki | Version: 1.0
Keywords: |
-----------------------+----------------------------------------------------
I would like us to use this ticket for tracking outdated documentation.
Anytime there is a source code change that requires some documentation to
be updated (and you won't update it right that moment), change this
description and add a bullet point describing the update. When we have
time we can go through the list and update the documentation, removing
those bullet points. This is a good way how to ensure we won't forget
about something.
Outdated documentation:
* '''Use of exceptions''' - AutoQA tests may no longer raise exceptions
arbitrarily (like !TestFail etc). Any exception raised means that the test
will end immediately and will be reported as CRASHED. If the tests
finishes fine (it doesn't matter if it passed or failed, it just matters
it has been executed fully), no exception must be raised.
* '''Self variables may be set any time''' - We have recommended to set
self.result and similar variables only at the end of the test (because of
our old exception handling). It is no longer the case. Self.* variables
may be set any time.
* '''Crontab file no longer installed''' - We no longer install crontab
file into /etc/cron.d/autoqa. Therefore there is no longer need to comment
out this file on clients. Also, this file must be created on servers (we
install a template as a documentation file).
--
Ticket URL: <https://fedorahosted.org/autoqa/ticket/232>
AutoQA <http://autoqa.fedorahosted.org>
Automated QA project
_______________________________________________
autoqa-devel mailing list
[email protected]
https://fedorahosted.org/mailman/listinfo/autoqa-devel
