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

vweb, x.vweb: edit some descriptions #21155

Merged
merged 2 commits into from
Apr 1, 2024
Merged

Conversation

kimshrier
Copy link
Contributor

I noticed that the bullet points under the Features heading on both vweb and x.vweb were not formatting right due to the line for "Easy to deploy" being continued on a second line.

It seems like that would be a bug in vdoc but I was unable to find it. The expedient fix is to just have that bullet point all on one line.

I also re-worded some other descriptive text to make it easier (at least for me) to understand.

I am not sure of the status of x.vweb vs. vweb. Using v new --web generates files referencing vweb so I assume that is still the preferred version.

@kimshrier
Copy link
Contributor Author

Looks like CI doesn't like the length of the "Easy to deploy" line. So the real fix is to track down the problem in vdoc.

If the other changes are deemed useful, I'll modify the merge request without the changes to the "Easy to deploy" line.

vlib/vweb/README.md Outdated Show resolved Hide resolved
@spytheman
Copy link
Member

For me on master, github shows:
image
(from https://github.com/vlang/v/blob/master/vlib/vweb/README.md)

While module.vlang.io shows:
image
(from https://modules.vlang.io/vweb.html)

@spytheman
Copy link
Member

It is formatted like this, because of this:
image

@spytheman
Copy link
Member

I am not sure of the status of x.vweb vs. vweb.

Afaik, x.vweb is intended to move to veb, and vweb, will stay for a while too, then it will be moved eventually to https://github.com/vlang/vweb as a module that is outside of vlib, and installable with v install vweb, for people that still depend on it.

@spytheman
Copy link
Member

The markdown parser that vdoc uses for the .md files is here: https://github.com/vlang/markdown . It is a wrapper of the https://github.com/mity/md4c library .

@spytheman
Copy link
Member

spytheman commented Apr 1, 2024

Imho what we can do for now, without a fix to the markdown parser, is move the problem item that needs wrapping, at the end of the list.

Then it will look like this:
image

@spytheman spytheman merged commit ecbd214 into vlang:master Apr 1, 2024
4 checks passed
@kimshrier kimshrier deleted the vweb_typos branch April 12, 2024 04:53
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.

None yet

2 participants