Vyxal / Vyxal

A code-golfing language experience that has aspects of traditional programming languages - terse, elegant, readable.

Home Page:https://vyxal.github.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Flag that generates explanation for Vyxal code.

PlaceReporter99 opened this issue · comments

It's nice when computers can do stuff for you.

Hey, @PlaceReporter99, that's a nice issue you've got there! It'd sure be a shame if somebody were to assign you to it!

It's not nice when computers can spam you.

commented

The only problem I have with automatically generated explanations is that they aren't helpful for understanding how a program works. Sure an auto generated explanation can tell you what each individual component of a program does, but it doesn't tell you how the components interact or any other logic. Also, it doesn't allow for easy semantic grouping (like how some people might group 2/* together as "half then multiply").

Maybe a flag that places the # at the end of each line would be a compromise - users could define semantic blocks that would be grouped on the same line with the explanation syntax already formatted for them. I think that would be a good and useful idea.

Secretly uses ChatGPT in compiler code to explain what it does

I think it would still be helpful, even without full semantic grouping. But we can detect, for example, a number/string literal next to a two/three-argument element.

commented

https://github.com/Vyxal/Luminespire

Rather than a flag, I've decided to make an external tool that:

a) can be customised to have special tools for vyxal (e.g. suggest a grouping scheme from things like arity grouping and modifiers or provide relevant keywords for each block) and
b) is otherwise language agnostic and can be used by the greater code golf community

So does that this mean this issue is going to be closed as won't complete?

I'm closing this as not planned for now because we have Luminespire. If lyxal decides this is a good idea in the future, we can reopen it.

I would say this is completed with the introduction of Luminespire.

Luminespire isn't a flag that automatically generates an explanation, so this hasn't been completed.

Lumenspire isn't a flag that automatically generates an explanation, so this hasn't been completed.

@nayakrujul but it has been completed. I view it as completed.

What? You think Luminespire is a "flag that generates explanations for Vyxal code"?

What? You think Luminespire is a "flag that generates explanations for Vyxal code"?

closest thing to one.

commented

What? You think Luminespire is a "flag that generates explanations for Vyxal code"?

Well actually Luminespire was intended to close this issue.

I'm closing this as not planned for now because we have Luminespire. If lyxal decides this is a good idea in the future, we can reopen it.

I won't be deciding it's a good idea to have it as a flag :p