objectbox / objectbox/objectbox-java

API cleanup

未关闭
#406 2 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

low priority
主要语言
Java
星标
4.6k
派生
311
PR 合并指标
30 天内没有已合并 PR

描述

Good evening,

I think it would be productive to clean up the API around the library a bit.

There are for example numerous methods/variables that are rather confusing (e.g. box.panicModeRemoveAll() and box.all2), and quite a few calls include "internal" in their names even though they are public. Is there a reason for this?

Its not the end of the world, but I do think it would make a difference - and one of the things I appreciated with Realm earlier on was how everything had its place. You could never see any of its implementation details, and you could fully focus on creating awesome stuff.

Thanks!
Zoltan

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

没有指定文件或测试。首先定位公共 API 符号 box.panicModeRemoveAll()box.all2 以及包含 internal 的方法,然后检查该库如何对外暴露它们。要视为完成,需要就清理范围达成一致,并在受影响的 API 中采用一致的公共命名。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
api
Issue 类型
重构
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
20/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。