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

Separate dirs for users and internal ones #594

Open
carpawell opened this issue Jul 5, 2024 · 3 comments
Open

Separate dirs for users and internal ones #594

carpawell opened this issue Jul 5, 2024 · 3 comments
Labels
enhancement Improving existing functionality I3 Minimal impact S3 Minimally significant U4 Nothing urgent
Milestone

Comments

@carpawell
Copy link
Member

The structure of the repo looks a little bit overwhelming now. We have structs for real users (object, nemap, etc) and some non-SDK things (doc, api, scripts, stat). Have you considered moving "SDK" things to a separate folder? Naming can be hard here but still.

Originally posted by @carpawell in #591 (review)

@carpawell
Copy link
Member Author

It was not a problem before but now we have api, docs, internal, scripts, stat dirs that are not expected to be used by a regular user (pool and waiter are also questionable to me but ok). We can place the all the "user" code to a separate dir or mark non-usable dirs somehow (e.g. start their name with _).

@roman-khimov
Copy link
Member

stat is an SDK thing. doc is not an issue. scripts are tolerable. api can either be hidden (internal) or renamed to something more meaningful. But the last thing I'd want is to move any of the packages we have now.

@carpawell
Copy link
Member Author

stat is an SDK thing

How can it be used? It has PoolStat and it allows to create PoolStat, used by the Pool only. Why is it at root level?

scripts are tolerable

Can not (should not) be used by a user that wants to work with neofs and goes to SDK.

But the last thing I'd want is to move any of the packages we have now.

We can move all the "internal" things to internal and leave all the "user" things as is.

@roman-khimov roman-khimov added this to the v1.0.0 milestone Jul 16, 2024
@roman-khimov roman-khimov added U4 Nothing urgent S3 Minimally significant I3 Minimal impact enhancement Improving existing functionality labels Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improving existing functionality I3 Minimal impact S3 Minimally significant U4 Nothing urgent
Projects
None yet
Development

No branches or pull requests

2 participants