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

Document the load src code from url, gist feature #111

Merged
merged 1 commit into from
Sep 17, 2023

Conversation

Shaikh-Ubaid
Copy link
Member

fixes #102

fixes #104

@github-actions
Copy link

Your site is deployed at https://lfortran.github.io/pull_request_preview/lfortran/111

@certik
Copy link
Contributor

certik commented Sep 16, 2023

Thanks for adding documentation. I think this does not fix #102, right? To fix it, we have to document that github will delay this by N minutes, or whatever exactly happens.

README.md Outdated

- Alternatively, users can load source code from a GitHub Gist by providing the Gist URL in the format: `https://dev.lfortran.org/?gist=<GitHub username>/<Gist ID>`.
- The compiler will fetch the raw content from the specified GitHub Gist.
- Note that GitHub Gist updates the raw content approximately every 5 minutes, so any changes made to the Gist may take about 5 minutes to reflect when loaded.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding documentation. I think this does not fix #102, right? To fix it, we have to document that github will delay this by N minutes, or whatever exactly happens.

Yes, I detailed it here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated/improved the wording.

@Shaikh-Ubaid Shaikh-Ubaid marked this pull request as draft September 16, 2023 15:22
@Shaikh-Ubaid Shaikh-Ubaid marked this pull request as ready for review September 16, 2023 15:28
@github-actions
Copy link

Your site is deployed at https://lfortran.github.io/pull_request_preview/lfortran/111

Copy link
Contributor

@certik certik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@Shaikh-Ubaid Shaikh-Ubaid merged commit facb896 into main Sep 17, 2023
1 check passed
@Shaikh-Ubaid Shaikh-Ubaid deleted the doc_load_src_code_from_url_gist branch September 17, 2023 02:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improving the "gist" experience Updated gist sometimes loads the old one
2 participants