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

Documentation improvements #155

Open
1 of 3 tasks
orangejulius opened this issue Jul 17, 2018 · 2 comments
Open
1 of 3 tasks

Documentation improvements #155

orangejulius opened this issue Jul 17, 2018 · 2 comments

Comments

@orangejulius
Copy link
Member

orangejulius commented Jul 17, 2018

It is not especially clear how to write tests for this library, and I suspect thus far everyone has gotten by through looking at existing tests, which means some nice features may not be used as much as they should.

Some things we should document

  • A few example test cases in general
  • Fully utilizing weights
  • Normalizers

Please add more if you can think of them

@orangejulius orangejulius changed the title Documentation improvements: Documentation improvements Oct 1, 2018
@ashleyha
Copy link

ashleyha commented Oct 4, 2018

This is great - clarifying the test pipeline, how to write tests, and difference between the types of tests should also be useful for those contributing to the city acceptance tests, for example. I saw that you also have some guidelines to writing good tests; it would be useful to update and include these in the documentation.

@orangejulius
Copy link
Member Author

Normalizers are now documented in #195!

orangejulius added a commit to pelias/documentation that referenced this issue May 5, 2020
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

No branches or pull requests

2 participants