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

Add doc references #54

Merged
merged 3 commits into from
Jul 3, 2023
Merged

Add doc references #54

merged 3 commits into from
Jul 3, 2023

Conversation

EmilyGraceSeville7cf
Copy link
Collaborator

No description provided.

@EmilyGraceSeville7cf EmilyGraceSeville7cf added the enhancement New feature or request label Jul 3, 2023
@EmilyGraceSeville7cf EmilyGraceSeville7cf self-assigned this Jul 3, 2023
@EmilyGraceSeville7cf EmilyGraceSeville7cf changed the title Add doc references Add doc references and intellisence Jul 3, 2023
@EmilyGraceSeville7cf
Copy link
Collaborator Author

PR is ready to merge. ;)

@DannyBen
Copy link
Owner

DannyBen commented Jul 3, 2023

Wait - what is the .vscode folder? What does it do?
Not sure I am interested in including editor specific configs...

@EmilyGraceSeville7cf
Copy link
Collaborator Author

EmilyGraceSeville7cf commented Jul 3, 2023

Wait - what is the .vscode folder? What does it do?

This folder contains VS Code specific settings to enable hints in .yaml files like here.

Not sure I am interested in including editor specific configs...

There is no way to enable intellisence otherwise. So if we remove, user should set up intellisence manually. I suggest then to remove .vscode folders from everywhere and just document how to recreate them and what contents with. And note that in any case, we have to deal with some editor settings: ship them out of the box or document how to set up them. Of course, everything above applies if we need hints in example configs or something like that.

@DannyBen
Copy link
Owner

DannyBen commented Jul 3, 2023

Ok... didn't notice we already have this in bashly.

  1. Can you screenshot how it looks? Preferably in bashly, where it seems more meaningful
  2. Where is the fixtures folder that it references? Do you mean spec/fixtures? This folder cannot be relied upon for anything other than specs

I suggest then to remove .vscode folders from everywhere and just document how to recreate them and what contents with.

  1. Wait before removal, I am still on the fence.
  2. I do not necessarily agree that there is any need to ship or document editor configs.

@EmilyGraceSeville7cf
Copy link
Collaborator Author

EmilyGraceSeville7cf commented Jul 3, 2023

Can you screenshot how it looks? Preferably in bashly, where it seems more meaningful

image

image

image

image

Where is the fixtures folder that it references? Do you mean spec/fixtures? This folder cannot be relied upon for anything other than specs

Yep, I mean spec/fixtures.

@DannyBen
Copy link
Owner

DannyBen commented Jul 3, 2023

Ok, thanks for the screens - it is clear now.

I don't think it is necessary here.
I am ok with either keeping or removing it from bashly.

@EmilyGraceSeville7cf
Copy link
Collaborator Author

So, should I remove it here?

@EmilyGraceSeville7cf EmilyGraceSeville7cf changed the title Add doc references and intellisence Add doc references Jul 3, 2023
@DannyBen
Copy link
Owner

DannyBen commented Jul 3, 2023

So, should I remove it here?

Yes please.

@EmilyGraceSeville7cf
Copy link
Collaborator Author

Done in the latest revert commit. PR is ready to be merged. :)

@DannyBen DannyBen merged commit 54dd259 into master Jul 3, 2023
@DannyBen DannyBen deleted the feature/add-doc-refs-to-json-schema branch July 3, 2023 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants