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

Fix help and documentation for record variables #3578

Closed
tfmorris opened this issue Feb 4, 2021 · 5 comments · Fixed by #4550
Closed

Fix help and documentation for record variables #3578

tfmorris opened this issue Feb 4, 2021 · 5 comments · Fixed by #4550
Assignees
Labels
Type: Bug Issues related to software defects or unexpected behavior, which require resolution. Type: Documentation Issues related to improving project documentation or tutorials.
Milestone

Comments

@tfmorris
Copy link
Member

tfmorris commented Feb 4, 2021

The current help for the record variable in the web client points to https://github.com/OpenRefine/OpenRefine/wiki/Variables#record, but that's just a stub that includes a generic link to the top level of the user manual.

It could be updated to point to https://docs.openrefine.org/manual/expressions#record, but it would be better to just include the documentation in the help, like everything else except the record variable.

Also, the manual's documentation could use improvement. For row.record.cells it says "The cells of the row" when it's a slice of cells from the record for the given column.

@tfmorris tfmorris added Type: Bug Issues related to software defects or unexpected behavior, which require resolution. Type: Documentation Issues related to improving project documentation or tutorials. labels Feb 4, 2021
@allanaaa
Copy link
Contributor

allanaaa commented Feb 4, 2021

I'm working on the in-tool help text right now, so that part is assigned to me.

I will take a look at the manual text after that, unless someone else gets to it first.

@allanaaa allanaaa self-assigned this Feb 4, 2021
@tfmorris
Copy link
Member Author

tfmorris commented Feb 4, 2021

OK, thanks, but in the meantime, I don't think it's very friendly to just be pointing folks at what is effectively a dead end. Any fix to the help is only going to affect future versions, not all the versions that are out in the field.

@allanaaa
Copy link
Contributor

allanaaa commented Feb 4, 2021

That part is up to @ostephens. Owen is taking care of manually redirecting the newly-blanked wiki pages to specific parts of the manual, so I will leave it to him whether he wants to do so for the URLs included in the Help text.

(In our spreadsheet I did mark a handful of wiki pages that are still in the codebase, but I didn't include the URLs that appear in the Help text.)

@tfmorris
Copy link
Member Author

tfmorris commented Feb 4, 2021

@ostephens Please do not replace specific content with generic links. I've fixed this page, but if there are any others, please fix them.

@ostephens
Copy link
Sponsor Member

@tfmorris sorry I was in the process of putting in the specific links last night but didn't get them all done before I had to stop. Those are all done.

allanaaa added a commit to allanaaa/OpenRefine that referenced this issue Feb 10, 2021
wetneb added a commit that referenced this issue Mar 15, 2021
* Expressions reorganizing

Moved GREL basics, Jython/Clojure to separate pages

Fix for https://groups.google.com/g/openrefine/c/Cvsg5IB4KZk

* Promoting some headers

* Fixed link

* Partial fix for #3578

* Add top-level item, fix links

Co-authored-by: Antonin Delpeuch <antonin@delpeuch.eu>
@wetneb wetneb added this to the 3.6 milestone Feb 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Issues related to software defects or unexpected behavior, which require resolution. Type: Documentation Issues related to improving project documentation or tutorials.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants