fix: Rename preview package file_converters to converters #6390
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why:
The purpose of this pull request is to rename package
file_converters
toconverters
. This change is aimed at broadening the scope or improving the clarity of the component names.What:
The modifications included renaming various elements of the codebase, from directories and files to references within the code. Renaming affected components like
TextFileToDocument
,TikaDocumentConverter
, and others. Additionally, the related documentation and tests have been updated to correspond with these new names.How can it be used:
Post-renaming, developers using the haystack library should now look for components under the
converters
namespace rather thanfile_converters
. For example, the use ofHTMLToDocument
will transition fromhaystack.preview.components.file_converters.html import HTMLToDocument
tohaystack.preview.components.converters.html import HTMLToDocument
. This change impacts how users will import and utilize these components in their pipelines or code.How did you test it:
Testing details have not been explicitly provided in the provided data. Typically, the testing procedure would involve running the existing unit tests ensuring all pass with the new naming convention. Additionally, ensuring that any documentation and quick-start guides reflect the changes to assist users in transition would be part of the testing procedure.
Notes for the reviewer:
Reviewers should focus on validating the completeness of the renaming process across the codebase. This includes ensuring that all instances of the old
file_converters
namespace are appropriately updated, verify that no references have been missed, and ensuring backwards compatibility or providing clear migration paths for users. Reviewers might also check for consistent naming conventions, proper documentation updates, and rerun all unit tests to confirm they pass with the updated names. It is also important to verify that any public APIs or exposed functionalities remain consistent or are properly documented if there are changes.