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

Documentation for v3.0 #220

Open
f3fora opened this issue May 18, 2022 · 8 comments
Open

Documentation for v3.0 #220

f3fora opened this issue May 18, 2022 · 8 comments
Labels
fix-docs Documentation needs to be/is being updated/fixed to avoid similar issues

Comments

@f3fora
Copy link
Contributor

f3fora commented May 18, 2022

doc/iron.txt is not about v3.0.

@hkupty
Copy link
Collaborator

hkupty commented May 18, 2022

Hi @f3fora,

Thanks for the issue. Yes, it is definitely missing. I'll update it.

@hkupty
Copy link
Collaborator

hkupty commented May 18, 2022

Hi @f3fora,

Just updated the docs. Let me know if something is still missing or not clear enough.

Best regards,
Henry

@hkupty hkupty added this to the 3.1 - Stabilization milestone May 18, 2022
@hkupty hkupty added the fix-docs Documentation needs to be/is being updated/fixed to avoid similar issues label May 18, 2022
@xllvrr
Copy link

xllvrr commented May 19, 2022

Hi,

If I can add to this, I'm not sure where the documentation for iron.view is as I previously had set my repl_open_cmd which now seems to require iron.view but the documentation currently on says 'Check iron.view for more options'

@hkupty
Copy link
Collaborator

hkupty commented May 19, 2022

Thanks for the heads up. I'll look up to improve that.

@jpoppe
Copy link

jpoppe commented Jun 1, 2022

Hi,

I just started testing this plugin, the new send_file mapping is missing from the documentation and iron crashes without this mapping (took me a while to figure this out). The key mappings on the README are also outdated.

@hkupty
Copy link
Collaborator

hkupty commented Jun 2, 2022

Hi @jpoppe

That mapping was just introduced, but I didn't have it mapped here and it wasn't breaking. can you share the error you got?
While that is indirectly related to the documentation, would you mind opening up a new issue just for this?

I'm pushing a commit to add the docs for send_file in both the README and doc/iron.txt

@jpoppe
Copy link

jpoppe commented Jun 2, 2022

Probably I was just pulling in between your commits from yesterday, I can't reproduce it anymore 👌🏻 (tried various options)

Thanks for your fast reply!

@hkupty
Copy link
Collaborator

hkupty commented Jun 2, 2022

All good! Glad it's working :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix-docs Documentation needs to be/is being updated/fixed to avoid similar issues
Projects
None yet
Development

No branches or pull requests

4 participants