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

Specify group of the component as doctag or section. #7336

Closed
Tracked by #7125
farmaazon opened this issue Jul 19, 2023 · 1 comment · Fixed by #7337
Closed
Tracked by #7125

Specify group of the component as doctag or section. #7336

farmaazon opened this issue Jul 19, 2023 · 1 comment · Fixed by #7337
Assignees
Labels
d-intermediate Difficulty: some prior knowledge required p-high Should be completed in the next sprint
Milestone

Comments

@farmaazon
Copy link
Contributor

farmaazon commented Jul 19, 2023

To make defining component groups easier, the entry's group should be specified in its docstring. This is a first step of implementing https://github.com/orgs/enso-org/discussions/7120.

The group list should be still in the package.yaml, and the "export" fields there may be honored.

@farmaazon farmaazon self-assigned this Jul 19, 2023
@farmaazon farmaazon added d-intermediate Difficulty: some prior knowledge required p-high Should be completed in the next sprint -gui labels Jul 19, 2023
@farmaazon farmaazon moved this from ❓New to 📤 Backlog in Issues Board Jul 19, 2023
@farmaazon farmaazon added this to the Beta Release milestone Jul 19, 2023
@farmaazon farmaazon mentioned this issue Jul 19, 2023
5 tasks
@farmaazon farmaazon moved this from 📤 Backlog to 🔧 Implementation in Issues Board Jul 20, 2023
@farmaazon farmaazon moved this from 🔧 Implementation to 🌟 Q/A review in Issues Board Jul 21, 2023
@farmaazon farmaazon moved this from 🌟 Q/A review to 🟢 Accepted in Issues Board Jul 24, 2023
@enso-bot
Copy link

enso-bot bot commented Jul 24, 2023

Adam Obuchowicz reports a new STANDUP for the last Friday (2023-07-21):

Progress: Finished implementation and created a PR, applied review comments. It should be finished by 2023-07-24.

Next Day: Next day I will be working on the #7313 task. Fix QA issues if any and take next task: Local scope filtering - or something else if there will be some pressing bug to fix.

mwu-tow pushed a commit that referenced this issue Jul 24, 2023
Fixes #7336 in a quick way.

Next to the old way of defining groups, the library can just add `GROUP` tag to some entities, and it will be added to the group specified in tag's description.

The group name may be qualified (with project name, like `Standard.Base.Input/Output`) or just name - in the latter case, IDE will assume a group defined in the same library as the entity.

Also moved some entities from "export" list in package.yaml to GROUP tag to give an example. I didn't move all of those, as I assume the library team will reorganize those groups anyway.

### Important Notes

@jdunkerley @radeusgd @GregoryTravis When you will start specifying groups in tags, remember that:
* The groups still belongs to a concrete project; if some entity outside a project wants to be added to its group, the "qualified" name should be specified. See `Table.new` example in this PR.
* If the group name does not reflect any group in package.yaml **the tag is ignored**.
* A single entity may be only in a single group. If it's specified in both package.yaml and in tag, the tag takes precedence.

---------

Co-authored-by: Ilya Bogdanov <[email protected]>
@farmaazon farmaazon moved this from 🟢 Accepted to 🗄️ Archived in Issues Board Jul 25, 2023
Frizi pushed a commit that referenced this issue Jul 25, 2023
Fixes #7336 in a quick way.

Next to the old way of defining groups, the library can just add `GROUP` tag to some entities, and it will be added to the group specified in tag's description.

The group name may be qualified (with project name, like `Standard.Base.Input/Output`) or just name - in the latter case, IDE will assume a group defined in the same library as the entity.

Also moved some entities from "export" list in package.yaml to GROUP tag to give an example. I didn't move all of those, as I assume the library team will reorganize those groups anyway.

@jdunkerley @radeusgd @GregoryTravis When you will start specifying groups in tags, remember that:
* The groups still belongs to a concrete project; if some entity outside a project wants to be added to its group, the "qualified" name should be specified. See `Table.new` example in this PR.
* If the group name does not reflect any group in package.yaml **the tag is ignored**.
* A single entity may be only in a single group. If it's specified in both package.yaml and in tag, the tag takes precedence.

---------

Co-authored-by: Ilya Bogdanov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d-intermediate Difficulty: some prior knowledge required p-high Should be completed in the next sprint
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant