Skip to content

Conversation

mpatrou
Copy link
Contributor

@mpatrou mpatrou commented Oct 10, 2024

Description of work

AlgoTimeRegister C++ class is exported to python:
addTime() and Instance() functions.

Summary of work

The AlgoTimeRegister is exposed in python, to allow users to measure time in python.

  • addTime(): adds a time log
  • Instance(): starts the clock
  • tests added
  • docs added

Further detail of work

for Expose Mantid::Instrumentation::AlgoTimeRegister to python

To test:

  • python3 /mantid/Framework/PythonInterface/test/python/mantid/api/AlgoRegisterTest.py AlgoTimeRegisterStartTest
  • python3 /mantid/Framework/PythonInterface/test/python/mantid/api/AlgoRegisterTest.py AlgoTimeRegisterAddTimeTest

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

This needs to be merged after Enable Profiling on Linux #38164

@github-actions github-actions bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label Oct 11, 2024
Copy link

👋 Hi, @mpatrou,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

@github-actions github-actions bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label Oct 11, 2024
@searscr searscr self-requested a review October 11, 2024 19:59
Copy link
Contributor

@searscr searscr left a comment

Choose a reason for hiding this comment

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

Works as expected, documentation explains usage well.

@sf1919 sf1919 added this to the Release 6.12 milestone Oct 14, 2024
@sf1919
Copy link
Contributor

sf1919 commented Oct 14, 2024

I've added a milestone. All PRs pointed at main that are not draft need to have a milestone for the audit trail.

@jmborr jmborr merged commit f169f23 into main Oct 15, 2024
10 checks passed
@jmborr jmborr deleted the addtime_export_p branch October 15, 2024 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants