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 code samples and remove useless ones #486

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Add code samples and remove useless ones #486

merged 2 commits into from
Oct 6, 2023

Conversation

curquiza
Copy link
Member

I created scripts to manage code samples (internal only)

  1. I found out the following code samples are still in this repo but not used by the documentation anymore, so I removed them:
meilisearch-ruby
- 'documents_guide_add_movie_1' not found in documentation
- 'faceted_search_2' not found in documentation
- 'faceted_search_facets_1' not found in documentation
- 'getting_started_communicating_with_a_protected_instance' not found in documentation
  1. I found the following code samples were missing:
meilisearch-rust
- 'search_parameter_guide_facet_stats_1' not found
- 'facet_search_1' not found
- 'facet_search_2' not found
- 'facet_search_3' not found

However, only search_parameter_guide_crop_marker_1, facet_search_2 were added/fixed, because of missing feature implementation for the others

@curquiza curquiza added the skip-changelog The PR will not appear in the release changelogs label Sep 21, 2023
index('books').update_faceting({ max_values_per_facet: 2 })
index('books').update_faceting({
max_values_per_facet: 2,
sort_facet_values_by: {
Copy link
Member Author

Choose a reason for hiding this comment

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

There is an issue open of this, can you confirm this code sample is still valid @brunoocasali?

@codecov
Copy link

codecov bot commented Sep 21, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (187b143) 99.60% compared to head (a1a955b) 99.60%.
Report is 6 commits behind head on main.

❗ Current head a1a955b differs from pull request most recent head be2805e. Consider uploading reports for the commit be2805e to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #486   +/-   ##
=======================================
  Coverage   99.60%   99.60%           
=======================================
  Files           9        9           
  Lines         508      508           
=======================================
  Hits          506      506           
  Misses          2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

.code-samples.meilisearch.yaml Outdated Show resolved Hide resolved
.code-samples.meilisearch.yaml Outdated Show resolved Hide resolved
.code-samples.meilisearch.yaml Outdated Show resolved Hide resolved
.code-samples.meilisearch.yaml Outdated Show resolved Hide resolved
Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

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

bors merge

@meili-bors
Copy link
Contributor

meili-bors bot commented Oct 6, 2023

@curquiza curquiza merged commit 01b1c89 into main Oct 6, 2023
6 checks passed
@curquiza curquiza deleted the fix-code-samples branch October 6, 2023 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants