Skip to content

Update README #373

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.

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

Merged
merged 5 commits into from
Sep 29, 2021
Merged

Update README #373

merged 5 commits into from
Sep 29, 2021

Conversation

willtebbutt
Copy link
Member

@willtebbutt willtebbutt commented Sep 28, 2021

Summary

The priorities seemed a bit out of date and, given that we don't really have a coherant list of priorities for this package at the minute, I figured it best to remove them for now.

In their place I propose a related work section.

Proposed changes

  • Remove priority list in README
  • Add related work section to README

What alternatives have you considered?

Trying to update the priorities to reflect where we are today. This turned out not to be possible, owing to a lack of a clear set of priorities.

Breaking changes

None

The priorities seemed a bit out of date and, given that we don't really have a super-coherant list of priorities for this package at the minute, I figured it best to remove them for now.

In their place I propose a related work section.
Copy link
Member

@st-- st-- left a comment

Choose a reason for hiding this comment

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

Seems sensible!

Would you want to keep a note that KernelFunctions is and will be AD-compatible though?

@willtebbutt
Copy link
Member Author

Would you want to keep a note that KernelFunctions is and will be AD-compatible though?

Good point. Yes, I want that.

@willtebbutt
Copy link
Member Author

@theogf @st-- added AD reference and removed reference to input transformations, because I'm not sure that input transformations will mean much to users first encountering the package. Happy to revert if the latter change is at all contentious.

willtebbutt and others added 2 commits September 29, 2021 14:04
@willtebbutt
Copy link
Member Author

@theogf @st-- happy with the state of this now?

Co-authored-by: Théo Galy-Fajou <[email protected]>
@willtebbutt
Copy link
Member Author

willtebbutt commented Sep 29, 2021

Thanks for the review @st-- @theogf @Crown421 . Will merge as-is (once CI passes) -- please open another PR if there's anything else that needs changing.

@willtebbutt willtebbutt merged commit 3356fa6 into master Sep 29, 2021
@willtebbutt willtebbutt deleted the wct/readme-update branch September 29, 2021 15:04
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