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

clean up some deprecated function #997

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Conversation

Yoorkin
Copy link
Collaborator

@Yoorkin Yoorkin commented Sep 14, 2024

remove some deprecated function:

  • fold_left, fold_right, fold_lefti, fold_righti, ...
  • List::concat_map, Ref::ref, Iter::tap
  • pop_exn, head_exn, nth_exn, ...
  • some util function in test package

Copy link
Contributor

coderabbitai bot commented Sep 14, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

peter-jerry-ye-code-review bot commented Sep 14, 2024

Based on the provided git diff output, it seems there are several deprecations and redundant functions being removed or updated across multiple files. Here are three key observations:

  1. Deprecation of new_with_index in Favor of makei:

    • The function Array::new_with_index and FixedArray::new_with_index are deprecated and replaced with Array::makei and FixedArray::makei respectively. This change is made to standardize the creation of arrays with index-based value initialization.
    • Suggestion: Ensure that all references to new_with_index are updated to use makei to maintain compatibility with future versions.
  2. Deprecation of Fold Functions:

    • Various fold functions like fold_left, fold_right, fold_lefti, and fold_righti are deprecated in favor of fold, rev_fold, foldi, and rev_foldi. This consolidation aims to reduce redundancy and simplify the API.
    • Suggestion: Update any use of the deprecated fold functions to their respective replacements to ensure future code stability and performance improvements, if any.
  3. Removal of Exception-Based Functions:

    • Functions like pop_exn, peek_exn, and similar are being removed in favor of their unsafe counterparts. This suggests a move towards more explicit error handling rather than relying on exceptions.
    • Suggestion: Review and update code to handle potential unsafe operations explicitly, such as using unsafe_pop instead of pop_exn, to manage exceptions more predictably and to adhere to the new design philosophy.

These changes indicate a move towards a more streamlined and standardized API, emphasizing explicit error handling and reducing redundancy. It's crucial to update affected codebases accordingly to avoid issues with future updates and to leverage the potential performance and maintainability benefits of the new design.

@coveralls
Copy link
Collaborator

coveralls commented Sep 14, 2024

Pull Request Test Coverage Report for Build 3159

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage remained the same at 0.0%

Files with Coverage Reduction New Missed Lines %
array/array.mbt 1 0.0%
Totals Coverage Status
Change from base Build 3157: 0.0%
Covered Lines: 0
Relevant Lines: 4761

💛 - Coveralls

@bobzhang
Copy link
Contributor

instead of removing them, shall we use the convention e.g, create a file called deprecated.mbt and put them all together to avoid some breakage. Keep them for a bit longer, e.g, a couple of months?

@Yoorkin
Copy link
Collaborator Author

Yoorkin commented Sep 19, 2024

instead of removing them, shall we use the convention e.g, create a file called deprecated.mbt and put them all together to avoid some breakage. Keep them for a bit longer, e.g, a couple of months?

putting them together in deprecated.mbt looks good to me

@Yoorkin Yoorkin marked this pull request as draft September 19, 2024 10:15
@qazxcdswe123
Copy link
Contributor

qazxcdswe123 commented Sep 20, 2024

Some may use @pkg.func, will this be affected if we move them to separated file?

@bobzhang
Copy link
Contributor

Some may use @pkg.func, will this be affected if we move them to separated file?

No, it is backwards compatible

@Yoorkin
Copy link
Collaborator Author

Yoorkin commented Oct 9, 2024

I found that it's quite dangerous to move functions around because some files are associated with target platforms. I have to check the moon.pkg.json and move them to deprecated_js.mbt, deprecated_nonjs.mbt, or deprecated_all.mbt carefully. It feels bad at experience.

Maybe it's better to move deprecated functions to the bottom of the files, or just keep them there? @bobzhang

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.

5 participants