Skip to content
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

add samples for pathExpectations of api-infix #999

Closed
2 tasks
robstoll opened this issue Oct 6, 2021 · 3 comments · Fixed by #1003
Closed
2 tasks

add samples for pathExpectations of api-infix #999

robstoll opened this issue Oct 6, 2021 · 3 comments · Fixed by #1003
Assignees
Milestone

Comments

@robstoll
Copy link
Owner

robstoll commented Oct 6, 2021

Platform (all, jvm, js, android): all
Extension (none, kotlin 1.3): none

Code related feature

We also want to provide samples for the infix api

Following the things you need to do:

  • copy PathExpectationSamples from fluent-api, adjust imports ...api.fluent... to ...api.infix... and adjust the samples accordingly (always use the infix syntax, never the fluent).
  • check that the sample in the KDoc Intellij is showing looks good (ALT+Mouse-click on function name) -- see ListExpectationSamples for how comments are written fir the infix API

Your first contribution?

  • Write a comment I'll work on this if you would like to take this issue over.
    This way we get the chance to revise the description in case things have changed in the meantime, we might give you additional hints and we can assign the task to you, so that others do not start as well.
  • See Your first code contribution for guidelines.
  • Do not hesitate to ask questions here or to contact us via Atrium's slack channel if you need help
    (Invite yourself in case you do not have an account yet).
@rhushikesh
Copy link
Contributor

I'll work on this

@rhushikesh
Copy link
Contributor

Hi @robstoll,

As this is my first PR in this project, I have one question to clarify.

Even though you mentioned copy PathExpectationSamples from fluent-api, adjust imports ...api.fluent... to ...api.infix... and adjust the samples accordingly (always use the infix syntax, never the fluent). in task list, we will need to add samples for infix functions for pathExpectations.

there are only 7 infix functions for pathExpectations where as for fluent there are 18 functions.

Please let me know if my understanding is correct.

@robstoll
Copy link
Owner Author

robstoll commented Oct 9, 2021

@rhushikesh good point, I forgot to mention, that some functions are still in pathAssertions.kt for binary backward compatibility reasons. You should have the same sample functions in the end as in PathExpectationSamples for api-fluent.

rhushikesh added a commit to rhushikesh/atrium that referenced this issue Oct 10, 2021
rhushikesh added a commit to rhushikesh/atrium that referenced this issue Oct 12, 2021
@robstoll robstoll added this to the 0.17.0 milestone Oct 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants